Support mdbook 0.5

[roberth]

Motivation

Unblock Nixpkgs.
Get the nice new page level table of contents to appear in the menu!

• Tested with mdbook: 0.4.52 -> 0.5.1 nixpkgs#467009

Context

• Closes Fails to build with mdbook >= 0.5.0 #14628
• Step towards reapplication of mdbook: 0.4.52 -> 0.5.0 nixpkgs#462777 (comment)

---

Add 👍 to pull requests you find important.

The Nix maintainer team uses a GitHub project board to schedule and track reviews.

[Ericson2314]

Does this mean we need your link checking PR even more now?

[roberth]

I'm sure mdbook-linkcheck will be updated at some point, but lychee is more capable anyway, in terms of checking the fragments too. Glad we have this better alternative now.
(There's potential for mdbook-linkcheck to have better UX by operating on the markdown, but that's even more hypothetical now)

[roberth]

I've added backport labels so that Nixpkgs can update mdbook. Only two labels for now; we'll see how that goes.

[internal-nix-ci]

Successfully created backport PR for 2.31-maintenance:

• [Backport 2.31-maintenance] Support mdbook 0.5 #14692

[internal-nix-ci]

Successfully created backport PR for 2.32-maintenance:

• [Backport 2.32-maintenance] Support mdbook 0.5 #14693

[internal-nix-ci]

Backport failed for 2.28-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.28-maintenance
git worktree add -d .worktree/backport-14690-to-2.28-maintenance origin/2.28-maintenance
cd .worktree/backport-14690-to-2.28-maintenance
git switch --create backport-14690-to-2.28-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.29-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.29-maintenance
git worktree add -d .worktree/backport-14690-to-2.29-maintenance origin/2.29-maintenance
cd .worktree/backport-14690-to-2.29-maintenance
git switch --create backport-14690-to-2.29-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.30-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.30-maintenance
git worktree add -d .worktree/backport-14690-to-2.30-maintenance origin/2.30-maintenance
cd .worktree/backport-14690-to-2.30-maintenance
git switch --create backport-14690-to-2.30-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.28-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.28-maintenance
git worktree add -d .worktree/backport-14690-to-2.28-maintenance origin/2.28-maintenance
cd .worktree/backport-14690-to-2.28-maintenance
git switch --create backport-14690-to-2.28-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.31-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.31-maintenance
git worktree add -d .worktree/backport-14690-to-2.31-maintenance origin/2.31-maintenance
cd .worktree/backport-14690-to-2.31-maintenance
git switch --create backport-14690-to-2.31-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.32-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.32-maintenance
git worktree add -d .worktree/backport-14690-to-2.32-maintenance origin/2.32-maintenance
cd .worktree/backport-14690-to-2.32-maintenance
git switch --create backport-14690-to-2.32-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.29-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.29-maintenance
git worktree add -d .worktree/backport-14690-to-2.29-maintenance origin/2.29-maintenance
cd .worktree/backport-14690-to-2.29-maintenance
git switch --create backport-14690-to-2.29-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.30-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.30-maintenance
git worktree add -d .worktree/backport-14690-to-2.30-maintenance origin/2.30-maintenance
cd .worktree/backport-14690-to-2.30-maintenance
git switch --create backport-14690-to-2.30-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.28-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.28-maintenance
git worktree add -d .worktree/backport-14690-to-2.28-maintenance origin/2.28-maintenance
cd .worktree/backport-14690-to-2.28-maintenance
git switch --create backport-14690-to-2.28-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.31-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.31-maintenance
git worktree add -d .worktree/backport-14690-to-2.31-maintenance origin/2.31-maintenance
cd .worktree/backport-14690-to-2.31-maintenance
git switch --create backport-14690-to-2.31-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.29-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.29-maintenance
git worktree add -d .worktree/backport-14690-to-2.29-maintenance origin/2.29-maintenance
cd .worktree/backport-14690-to-2.29-maintenance
git switch --create backport-14690-to-2.29-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.32-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.32-maintenance
git worktree add -d .worktree/backport-14690-to-2.32-maintenance origin/2.32-maintenance
cd .worktree/backport-14690-to-2.32-maintenance
git switch --create backport-14690-to-2.32-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.30-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.30-maintenance
git worktree add -d .worktree/backport-14690-to-2.30-maintenance origin/2.30-maintenance
cd .worktree/backport-14690-to-2.30-maintenance
git switch --create backport-14690-to-2.30-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.31-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.31-maintenance
git worktree add -d .worktree/backport-14690-to-2.31-maintenance origin/2.31-maintenance
cd .worktree/backport-14690-to-2.31-maintenance
git switch --create backport-14690-to-2.31-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[internal-nix-ci]

Backport failed for 2.32-maintenance, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin 2.32-maintenance
git worktree add -d .worktree/backport-14690-to-2.32-maintenance origin/2.32-maintenance
cd .worktree/backport-14690-to-2.32-maintenance
git switch --create backport-14690-to-2.32-maintenance
git cherry-pick -x 2636f50dd41fe357ec64430aeeb772328ab2d7cb 0aef1ddb9ee5b706be03e4956af9300fdbed4a97

[xokdvium]

Hm, how come the backport action has gone crazy?

[roberth]

I think it happened because I added labels later. I guess it gets an event per label, but then tries to apply all of them for each event?

Anyway, backports 2.31 and 2.32 worked. I'll do 2.30 now.

[nunotexbsd]

I did apply patch to nix and rebuilded with mdbook 0.5.1 and it seems that a suffix was added to generated docs:

ex: book.js -> book-a0b12cfe.js

===> Checking for items in STAGEDIR missing from pkg-plist
Error: Orphaned: %%DOCSDIR%%/manual/ayu-highlight-3fdfc3ac.css
Error: Orphaned: %%DOCSDIR%%/manual/book-a0b12cfe.js
Error: Orphaned: %%DOCSDIR%%/manual/clipboard-1626706a.min.js
Error: Orphaned: %%DOCSDIR%%/manual/css/chrome-ae938929.css
<snip>

===> Checking for items in pkg-plist which are not in STAGEDIR
Error: Missing: %%DOCSDIR%%/manual/ayu-highlight.css
Error: Missing: %%DOCSDIR%%/manual/book.js
Error: Missing: %%DOCSDIR%%/manual/clipboard.min.js
Error: Missing: %%DOCSDIR%%/manual/css/chrome.css
<snip>

[roberth]

@nunotexbsd Those are cache busting suffixes, and as long as they're only in "support" resources that are not linked directly, they're perfectly fine.
I don't see them on any html files, so I don't think we have a real problem here.
Thank you for checking ❤️