Problem/Motivation

Track the steps needed to deprecate extension Shortcut from core to contrib. See Remove a core extension and move it to a contributed project of the deprecation policy.

The removal of extension Shortcut was approved in #3476880: [Policy] Move Shortcut module to contrib.

Remaining tasks

Postponed on any sibling issues,

  1. Create a section on Deprecated and obsolete modules and themes to provide recommendations for sites using extension Shortcut. The recommendations are to include instructions for sites using the extension and for contributed projects that depend on then extension.
  2. Add the following to the extension info.yml file

    3. lifecycle: deprecated
    lifecycle_link: https://www.drupal.org/node/3223395#shortcut

  3. Add #[IgnoreDeprecations] to all tests in the extension.
  4. Add a change record and include a link the the doc page.
  5. Deprecate any library that is only used by the extension.
  6. Do a thorough search of core for any remaining references to the extension. If references are found, outside of the extension, then creates issues to remove the references.

Release notes snippet

Issue fork drupal-3569118

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

quietone created an issue. See original summary.

quietone opened merge request !14462

quietone’s picture

quietone commented
Status: Postponed (maintainer needs more info) » Postponed

andypost made their first commit to this issue’s fork.

andypost’s picture

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

as removed from standard profile/recipes

andypost’s picture

andypost
he/him
Primary language Russian
commented
Related issues: +#3569152: Move some test coverage to the Shortcut module

Looks before deprecation we need to split tests via #3569152: Move some test coverage to the Shortcut module

quietone’s picture

quietone commented
Status: Needs work » Postponed

This is postponed on the sibling issues.

andypost’s picture

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

tests moved

andypost’s picture

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

Looks ready to go

andypost’s picture

andypost
he/him
Primary language Russian
commented

CR https://www.drupal.org/node/3578141

Now needs a page update at https://www.drupal.org/docs/core-modules-and-themes/deprecated-and-obsol...

quietone’s picture

quietone commented
Issue summary: View changes
Status: Needs review » Postponed

This is postponed on the sibling issues. I have updated the issue summary.

andypost’s picture

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

Siblings are commited and project moved to contrib already

smustgrave’s picture

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

lets do it!

sivaji_ganesh_jojodae made their first commit to this issue’s fork.

sivaji_ganesh_jojodae’s picture

sivaji_ganesh_jojodae commented
Status: Reviewed & tested by the community » Needs work

The test method testAccessShortcutsPermission is throwing error.

nicxvan’s picture

nicxvan commented

Does the core module list provider need to be updated?

smustgrave’s picture

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

Seems the ignore deprecation was removed in #3576579: Tidy up and tighten deprecation ignores and tests marked #[IgnoreDeprecations] where no deprecations are triggered by mistake. Since it was a small fix moving back

catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Needs work 
ClaroBlockFilterTest.php 
ClaroTest.php 
AdminTest.php

These three tests shouldn't be changed here, we need to refactor them to not rely on shortcut module, or move shortcut-specific assertions to shortcut module, or something like that.

quietone’s picture

quietone commented
Status: Needs work » Postponed

Just catching up here.

The deprecation issue for an extension should only have the deprecation nothing else. The issue summary has the correct scope. All the other steps in the parent need to be completed. The parent issue should always been checked for anything remaining instances that need to be changed. I do see my earlier comment wasn't clear on that point, so trying again now.

smustgrave’s picture

smustgrave commented
Issue summary: View changes
Status: Postponed » Needs work

Blockers are in

smustgrave’s picture

smustgrave commented
Issue summary: View changes
Status: Needs work » Needs review

Added a section to https://www.drupal.org/node/3223395

Rebased the MR and updated the link to include s-

Believe we are good here.

andypost’s picture

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

Looks ready

quietone’s picture

quietone commented
Status: Reviewed & tested by the community » Needs work

There is a failing test, core/modules/shortcut/tests/src/Functional/NavigationSafeBlockDefinitionTest.php

smustgrave’s picture

smustgrave commented
Status: Needs work » Needs review

ckeditor5 failures I believe are unrelated

quietone’s picture

quietone commented
Status: Needs review » Needs work

#18 has not been addressed here. And like those, I think NavigationSafeBlockDefinitionTest.php needs to be redone, a Navigation test should not be loading a deprecated plugin.

We need a new issue for those 4 tests.

smustgrave’s picture

smustgrave commented

It’s a shortcut test? I don’t follow

quietone’s picture

quietone commented
Status: Needs work » Postponed
quietone’s picture

quietone commented

There are two tests with the same name and I got them mixed up. Sorry about that!
So, it is just $18 which can be done in #3617978: Adjust more tests to deprecate Shortcut

quietone’s picture

quietone commented
Status: Postponed » Needs review

So, it turns out that those tests do not need the IgnoreDeprecations attribute.

Now there is only one test where an IgnoreDeprecations is added outside of the shortcut module. That is core/tests/Drupal/KernelTests/Core/Extension/ModuleConfigureRouteTest.php.

smustgrave’s picture

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

So believe this one is good to go?

  • catch committed 9897661f on 11.x 
    task: #3569118 Deprecate the Shortcut module

By: quietone
By: andypost...

  • catch committed ca437034 on main 
    task: #3569118 Deprecate the Shortcut module

By: quietone
By: andypost...
catch’s picture

catch
he/him
Primary language English
commented
Version: main » 11.x-dev
Status: Reviewed & tested by the community » Fixed

Committed/pushed to main and 11.x, thanks!

Manually resolved a merge conflict in ModuleConfigureRouteTest when cherry-picking to 11.x - just the code comment was different.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

andypost’s picture

andypost
he/him
Primary language Russian
commented

CR looks like need update as removal supposed in 13.x

catch’s picture

catch
he/him
Primary language English
commented

@andypost no this will still be removed in Drupal 12.0.0 - where we're moving modules contrib we've been doing that right up until the next major release because it tends to be a very easy change for sites to make.

  • catch committed 2c0190ef on 11.x 
    Revert "task: #3569118 Deprecate the Shortcut module"

This reverts...
catch’s picture

catch
he/him
Primary language English
commented
Status: Fixed » Patch (to be ported)

Had to revert from 11.x https://git.drupalcode.org/project/drupal/-/jobs/11698894 - update and migrate test failures.

quietone’s picture

quietone commented

The tests are fixed in #2672340: user_user_role_insert should not exist, so lets wait for that to be committed.

  • catch committed dfc8b0f6 on 11.x 
    Reapply "task: #3569118 Deprecate the Shortcut module"

This reverts...
catch’s picture

catch
he/him
Primary language English
commented
Status: Patch (to be ported) » Fixed

Ah I should have realised those were the same test failures. That issue landed, so re-applied this to 11.x, thanks!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

catch’s picture

catch
he/him
Primary language English
commented

Kicked off a manual daily pipeline after both commits went into 11.x and confirmed this doesn't introduce any new test failures on the branch.

Status: Fixed » Closed (fixed)

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