Problem/Motivation

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

The removal of extension Book was approved in #3265493: [Policy] Move book to contrib in Drupal 11.

Remaining tasks

postponed on

  1. Create a section on Deprecated and obsolete modules and themes to provide recommendations for sites using the Book module. 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#s-book

  4. Add @group legacy to all tests in the extension.
  5. Add a change record and include a link the the doc page.
  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

CommentFileSizeAuthor
#21 3413932-nr-bot.txt90 bytesneeds-review-queue-bot

Issue fork drupal-3413932

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:

Comments

quietone created an issue. See original summary.

quietone’s picture

Issue summary: View changes
quietone’s picture

Status: Active » Postponed

quietone’s picture

Status: Postponed » Needs work
spokje’s picture

So our decision to not remove the deprecated modules related CSS in 10.3.x, but rather in 11.x bites us here.

core/themes/olivero/config/optional/block.block.olivero_book_navigation.yml has a dependency on book, which triggers a deprecation in \Drupal\KernelTests\Config\DefaultConfigTest::testThemeConfig.

Not quite sure what to do here, maybe special case this situation in DefaultConfigTest, either specific for olivero and books, or better in general?

catch’s picture

If modules can provide default config for themes, we could move the block over and not the CSS, but... can they even do that??

larowlan’s picture

Yeah dependencies supports thèmes sonth so that should be doable - nice idea!

spokje’s picture

Ok, so I moved the dependency and block settings over to a optional config yaml in the book module, that didn't break too much, but I like to be sure this is the correct approach before trying to fix the new test-failures.

catch’s picture

From looking at a couple of the test failures they look like ones we'd probably have to deal with when we move book out of core - like comparing default config etc. if that's the case then I think it makes sense to do it this way.

spokje’s picture

Testfailures where due to me not moving the whole block but trying to be clever.
(Trust me, that never works out...)

Straight up move of the block.block.olivero_book_navigation.yml to the book module appeases all tests.

spokje’s picture

Status: Needs work » Needs review
smustgrave’s picture

Could a CR be added?

spokje’s picture

Ah sorry, thought one was already there.
It wasn't, added one.

smustgrave’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: +Needs Review Queue Initiative

Thanks! Reviewing this like I did Forum and believe everything has been addressed.

larowlan’s picture

Status: Reviewed & tested by the community » Postponed

We need a stable release of the contrib module before we can proceed here

Thanks

quietone’s picture

Issue summary: View changes
andypost’s picture

Issue summary: View changes

Contrib module created but one blocker still here

catch’s picture

Just committed the blocker.

andypost’s picture

Assigned: Unassigned » pwolanin
Status: Postponed » Needs review

@pwolanin Now it needs to move code to contrib module according to https://www.drupal.org/about/core/policies/core-change-policies/module-o...

After that RTBC +1

needs-review-queue-bot’s picture

Status: Needs review » Needs work
StatusFileSize
new90 bytes

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

catch’s picture

Status: Needs work » Postponed

This still needs a stable release of the contrib module per #16 at https://www.drupal.org/project/book

smustgrave’s picture

Will do one by 10.3 for sure. Think we were waiting for #3422862: Add validation constraints to book.settings and #3424509: Update MigratePluginManager to include both attribute and annotation class to land to avoid multiple subtree splits.

But if we can do the sub-tree split without those and just backport manually without a full sub-tree split we can do a release today.

catch’s picture

#3422862: Add validation constraints to book.settings may have its own dependencies, so I don't think the book subtree split should wait on it. If it had already gone in, it would have been worth waiting for, but it's still got open questions so might not even land in 10.3.x

#3424509: Update MigratePluginManager to include both attribute and annotation class looks a bit closer so might still be worth trying to push that through first.

However we're coming up close to the 10.3 beta deadline, and still need to do module removals and update test fixture changes in the next three to four weeks. I'm not sure if/how many fixtures include book module, but if they do, then it might be better to just go ahead here.

smustgrave’s picture

Status: Postponed » Needs work

Migrate one just landed so we can do the sub tree split.

smustgrave’s picture

Status: Needs work » Needs review

A 1.0.0 release has been made for book

Rebased this MR.

smustgrave’s picture

Status: Needs review » Reviewed & tested by the community

I really just rebased this. Work was already done so think I'm good to RTBC.

  • catch committed 93953aba on 10.3.x
    Issue #3413932 by quietone, Spokje, smustgrave, andypost, catch,...

  • catch committed ec1dd1b3 on 11.x
    Issue #3413932 by quietone, Spokje, smustgrave, andypost, catch,...
catch’s picture

Version: 11.x-dev » 10.3.x-dev
Status: Reviewed & tested by the community » Fixed

Reviewed this again, all looks straightforwards. Some core modules I am pleased about deprecating and have been trying to get rid of for years, but I still like and use book module so this is a shame, but it's just not used as much as it was, and there are other options in contrib these days too. I'll need to install the contrib book module for at least one site.

Committed/pushed to 11.x and cherry-picked to 10.3.x, thanks!

quietone’s picture

Assigned: pwolanin » Unassigned

Publish CR

Status: Fixed » Closed (fixed)

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