Support mdbook 0.5 #14690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

Ericson2314 merged 2 commits into NixOS:master from roberth:mdbook-0.5

Dec 2, 2025

Member

roberth commented Dec 2, 2025 •

edited

Loading

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.

roberth added 2 commits

December 2, 2025 02:38


          maint: Remove mdbook-linkcheck and support mdbook 0.5.x

2636f50

Fixes NixOS#14628

- Remove mdbook-linkcheck dependency and configuration (was blocking
  upgrades to mdbook 0.5.0+, configured with warning-policy = "ignore"
  due to false positives, and redundant with lychee-based link checking)
- Update substitute.py and anchors.jq to handle 'items' (mdbook 0.5.x)
  in addition to 'sections' (mdbook 0.4.x), as per mdbook 0.5.0
  changelog: "Book::sections was renamed to Book::items"
  https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#05-migration-guide


          maint: Fix lowdown override compatibility with newer nixpkgs

0aef1dd

Use `or ""` fallback for postInstall attribute which may not exist in
newer nixpkgs versions of lowdown.

roberth requested a review from edolstra as a code owner

December 2, 2025 01:51

github-actions bot added the documentation label

roberth mentioned this pull request

mdbook: 0.4.52 -> 0.5.1 NixOS/nixpkgs#467009

Merged

21 tasks

roberth added backport 2.31-maintenance backport 2.32-maintenance labels

Ericson2314 approved these changes

View reviewed changes

Member

Ericson2314 left a comment

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

Member Author

roberth commented Dec 2, 2025

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)

Member Author

roberth commented Dec 2, 2025

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

Ericson2314 added this pull request to the merge queue

Merged via the queue into NixOS:master with commit ec6789f

19 checks passed

internal-nix-ci bot mentioned this pull request

[Backport 2.31-maintenance] Support mdbook 0.5 #14692

Merged

internal-nix-ci bot commented Dec 2, 2025

Successfully created backport PR for 2.31-maintenance:

[Backport 2.31-maintenance] Support mdbook 0.5 #14692

internal-nix-ci bot mentioned this pull request

[Backport 2.32-maintenance] Support mdbook 0.5 #14693

Merged

internal-nix-ci bot commented Dec 2, 2025

Successfully created backport PR for 2.32-maintenance:

[Backport 2.32-maintenance] Support mdbook 0.5 #14693

roberth added backport 2.28-maintenance backport 2.29-maintenance backport 2.30-maintenance labels

internal-nix-ci bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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 bot commented Dec 2, 2025

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

Contributor

xokdvium commented Dec 2, 2025

Hm, how come the backport action has gone crazy?

Member Author

roberth commented Dec 2, 2025

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.

roberth mentioned this pull request

Backport #14690 to 2.30: Support mdbook 0.5.x #14695

Merged

nunotexbsd commented Dec 2, 2025 •

edited

Loading

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>

Member Author

roberth commented Dec 3, 2025

@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 ❤️

edolstra added a commit that referenced this pull request


          Merge pull request #14695 from roberth/backport-14690-to-2.30

5cbd785

Backport #14690 to 2.30: Support mdbook 0.5.x

edolstra mentioned this pull request

2.33 release notes #14752

Merged

roberth added a commit to roberth/nixpkgs that referenced this pull request


          nixVersions.git: 2.33pre20251107_479b6b73 -> 2.34pre20251217_b6add8dc

bd07e0e

Update to latest Nix master which includes mdbook 0.5 support merged in
PR NixOS#14690.

NixOS/nix#14690

roberth added a commit to roberth/nixpkgs that referenced this pull request


          nixVersions.git: 2.33pre20251107_479b6b73 -> 2.34pre20251217_b6add8dc

0768ca2

Update to latest Nix master which includes mdbook 0.5 support merged in
PR NixOS#14690.

NixOS/nix#14690

philiptaron added a commit to philiptaron/nixpkgs that referenced this pull request


          nixVersions.nix_2_31: 2.31.2 -> 2.31.3

b766136

## Bug fixes (crashes)

- Fix segfaults from `toView()` when compiled with newer nixpkgs (NixOS/nix#14154)
- Fix use-after-move in `DerivationGoal::repairClosure` and `SampleStack` (NixOS/nix#14086)
- Fix assertion failure on partially valid derivation outputs (NixOS/nix#14137)
- Fix `RestrictedStore::addDependency` recursion causing crashes (NixOS/nix#14729)
- Fix crash on flakerefs containing newlines (NixOS/nix#14450)

## Bug fixes (functionality)

- Fix fakeSSH check breaking SSH copies with `user@host` format (NixOS/nix#14150)
- Fix `builtins.dirOf` regression from Nix 2.23 (NixOS/nix#14515)
- Restore missing `isAllowed` check in `ChrootLinuxDerivationBuilder` (NixOS/nix#14531)
- Fix curl with c-ares failing to resolve DNS in sandbox on macOS (NixOS/nix#14792)
- Fix tarball percent decoding for `file://` URIs (NixOS/nix#14729)
- `exportReferencesGraph`: Handle heterogeneous arrays (NixOS/nix#13861)
- Fix filesystem ops in store optimization (NixOS/nix#14676)

## Bug fixes (output)

- Fix double-quoting of paths in logs (NixOS/nix#14210)
- Include path in world-writable error messages (NixOS/nix#14785)

## Improvements

- Better git refnames validation (NixOS/nix#14253)
- Use pure/restricted eval for help pages (NixOS/nix#14156)
- Improve store-reference compatibility with IPv6 ZoneId literals (NixOS/nix#14134)
- Correct `build-dir` error in manual (NixOS/nix#14745)

## Build system

- Add mdbook 0.5 support (NixOS/nix#14690)
- Drop legacy Apple SDK pattern (NixOS/nix#13976)

https://github.com/NixOS/nix/releases/tag/2.31.3

philiptaron added a commit to philiptaron/nixpkgs that referenced this pull request


          nixVersions.nix_2_31: 2.31.2 -> 2.31.3

beb3263

Changelog of fixes:

## Bug fixes (crashes)

- Fix segfaults from `toView()` when compiled with newer nixpkgs (NixOS/nix#14154)
- Fix use-after-move in `DerivationGoal::repairClosure` and `SampleStack` (NixOS/nix#14086)
- Fix assertion failure on partially valid derivation outputs (NixOS/nix#14137)
- Fix `RestrictedStore::addDependency` recursion causing crashes (NixOS/nix#14729)
- Fix crash on flakerefs containing newlines (NixOS/nix#14450)

## Bug fixes (functionality)

- Fix fakeSSH check breaking SSH copies with `user@host` format (NixOS/nix#14150)
- Fix `builtins.dirOf` regression from Nix 2.23 (NixOS/nix#14515)
- Restore missing `isAllowed` check in `ChrootLinuxDerivationBuilder` (NixOS/nix#14531)
- Fix curl with c-ares failing to resolve DNS in sandbox on macOS (NixOS/nix#14792)
- Fix tarball percent decoding for `file://` URIs (NixOS/nix#14729)
- `exportReferencesGraph`: Handle heterogeneous arrays (NixOS/nix#13861)
- Fix filesystem ops in store optimization (NixOS/nix#14676)

## Bug fixes (output)

- Fix double-quoting of paths in logs (NixOS/nix#14210)
- Include path in world-writable error messages (NixOS/nix#14785)

## Improvements

- Better git refnames validation (NixOS/nix#14253)
- Use pure/restricted eval for help pages (NixOS/nix#14156)
- Improve store-reference compatibility with IPv6 ZoneId literals (NixOS/nix#14134)
- Correct `build-dir` error in manual (NixOS/nix#14745)

## Build system

- Add mdbook 0.5 support (NixOS/nix#14690)
- Drop legacy Apple SDK pattern (NixOS/nix#13976)

https://github.com/NixOS/nix/releases/tag/2.31.3

philiptaron mentioned this pull request

nixVersions.nix_2_31: 2.31.2 -> 2.31.3 NixOS/nixpkgs#478158

Merged

13 tasks

philiptaron added a commit to philiptaron/nixpkgs that referenced this pull request


          nixVersions.nix_2_31: 2.31.2 -> 2.31.3

a4ef4c1

Changelog of fixes:

## Bug fixes (crashes)

- Fix segfaults from `toView()` when compiled with newer nixpkgs (NixOS/nix#14154)
- Fix use-after-move in `DerivationGoal::repairClosure` and `SampleStack` (NixOS/nix#14086)
- Fix assertion failure on partially valid derivation outputs (NixOS/nix#14137)
- Fix `RestrictedStore::addDependency` recursion causing crashes (NixOS/nix#14729)
- Fix crash on flakerefs containing newlines (NixOS/nix#14450)

## Bug fixes (functionality)

- Fix fakeSSH check breaking SSH copies with `user@host` format (NixOS/nix#14150)
- Fix `builtins.dirOf` regression from Nix 2.23 (NixOS/nix#14515)
- Restore missing `isAllowed` check in `ChrootLinuxDerivationBuilder` (NixOS/nix#14531)
- Fix curl with c-ares failing to resolve DNS in sandbox on macOS (NixOS/nix#14792)
- Fix tarball percent decoding for `file://` URIs (NixOS/nix#14729)
- `exportReferencesGraph`: Handle heterogeneous arrays (NixOS/nix#13861)
- Fix filesystem ops in store optimization (NixOS/nix#14676)

## Bug fixes (output)

- Fix double-quoting of paths in logs (NixOS/nix#14210)
- Include path in world-writable error messages (NixOS/nix#14785)

## Improvements

- Better git refnames validation (NixOS/nix#14253)
- Use pure/restricted eval for help pages (NixOS/nix#14156)
- Improve store-reference compatibility with IPv6 ZoneId literals (NixOS/nix#14134)
- Correct `build-dir` error in manual (NixOS/nix#14745)

## Build system

- Add mdbook 0.5 support (NixOS/nix#14690)
- Drop legacy Apple SDK pattern (NixOS/nix#13976)

https://github.com/NixOS/nix/releases/tag/2.31.3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 2.28-maintenance backport 2.29-maintenance backport 2.30-maintenance backport 2.31-maintenance backport 2.32-maintenance documentation