Problem/Motivation

In #3037230: Finalize the merge of Help Topics into Help the help topics module was merged to help one and deprecated

Proposed resolution

- remove module remains and leave obsolete(hidden - not visible) module stub to allow test update hooks from help module
- added mention to list of obsolete modules https://www.drupal.org/node/3223395#s-help-topics

Remaining tasks

review/commit

User interface changes

API changes

Data model changes

Release notes snippet

CommentFileSizeAuthor
#14 update-no-topics.png70.07 KBandypost

Issue fork drupal-3433019

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

andypost created an issue. See original summary.

andypost opened merge request !7162

andypost’s picture

andypost
he/him
Primary language Russian
commented
Assigned: andypost » Unassigned
Status: Active » Needs review
spokje’s picture

spokje
Primary language Dutch
commented

After applying the MR I still see a few textual references to the help_topics module and at least two test modules with the name help_topics in them.

I guess we want to remove all of those as well?

andypost’s picture

andypost
he/him
Primary language Russian
commented
Related issues: +#3414563: Add new 10.3.x database dump fixtures, without modules deprecated for removal in 11.x
andypost’s picture

andypost
he/him
Primary language Russian
commented

@Spokje I see no mentions, all from git grep help_topics is related to help module

Only update hooks has 2 mentions but I see no reason to remove it

spokje’s picture

spokje
Primary language Dutch
commented

Ah, so something like hook_help_topics_info_alter is actually used by the help module?

andypost’s picture

andypost
he/him
Primary language Russian
commented

Yes, help topics are plugins)

andypost’s picture

andypost
he/him
Primary language Russian
commented

btw it's time to release as project https://www.drupal.org/sandbox/jhodgdon/2369943

andypost’s picture

andypost
he/him
Primary language Russian
commented
Related issues: +#3416928: [Meta] Remove updates added up until 10.3.0 from Drupal 11
smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

All removal so easy to review. Removal didn't break anything so looks fine to me.

catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Needs work

I don't think we can go straight to removal. The problem is that if you have a site with help_topics enabled, and update to 11.x, you'll get the missing module error message, then you can't uninstall it because it's not in the filesystem.

For previous merged modules, we've marked them obsolete, with an update to uninstall them, and a hook_requirements() to prevent them being re-installed. That guarantees the module is uninstalled everywhere, so it can then be safely removed in 12.x

All the other code can be removed though, so most of the MR is fine.

andypost’s picture

andypost
he/him
Primary language Russian
commented

The module is uninstalled by help module's post update hook, so we can remove it safely until the hook is here

andypost’s picture

andypost
he/him
Primary language Russian
commented
StatusFileSize
new update-no-topics.png70.07 KB

update hook is not enough as screenshot points, so I marked module obsolete

so it allows to remove the obsolete stub in 12.x

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Needs work » Needs review
catch’s picture

catch
he/him
Primary language English
commented

This looks good but it also needs a hook_requirements() to prevent the module being re-installed. Any existing or 9.5 obsolete module should have one as an example.

andypost’s picture

andypost
he/him
Primary language Russian
commented
Related issues: +#2942096: [policy, no patch] Remove old update hooks prior to each major version (Drupal 10 and later)

So the stub should be obsolete and hidden, and all tests pass

andypost’s picture

andypost
he/him
Primary language Russian
commented
Title: Remove deprecated help_topics module » Replace deprecated help_topics module with obsolete stub

Hope the better title and may need CR

andypost’s picture

andypost
he/him
Primary language Russian
commented

But there's existing CR https://www.drupal.org/node/3382015 which can be linked here

andypost’s picture

andypost
he/him
Primary language Russian
commented
Issue summary: View changes

updated IS

catch’s picture

catch
he/him
Primary language English
commented
Status: Needs review » Needs work

Still needs the hook_requirements() to prevent the module from being enabled.

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Needs work » Needs review

obsolete/hidden state - means it can't be installed via UI and prevents drush from doing it

/var/www/html/web $ drush en help_topics

In ModuleInstaller.php line 122:
                                                                
  Unable to install modules: module 'help_topics' is obsolete.
andypost’s picture

andypost
he/him
Primary language Russian
commented

But the module still available to uninstall via UI!

catch’s picture

catch
he/him
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Sorry I forgot we added this support to obsolete modules centrally instead of the hook_requirements(), in that case, it looks good to me!

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed

Committed 31e7810 and pushed to 11.x. Thanks!

  • alexpott committed 31e7810e on 11.x 
    Issue #3433019 by andypost, catch: Replace deprecated help_topics module...

andypost closed merge request !7162

andypost’s picture

andypost
he/him
Primary language Russian
commented

There's follow-up for CI job #3436055: Validatable config should skip obsolete modules

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.