Skip to content

testers.lycheeLinkCheck: improve root-relative link UX#520792

Merged
philiptaron merged 1 commit into
NixOS:masterfrom
roberth:lychee-link-check-relocatable
Jun 10, 2026
Merged

testers.lycheeLinkCheck: improve root-relative link UX#520792
philiptaron merged 1 commit into
NixOS:masterfrom
roberth:lychee-link-check-relocatable

Conversation

@roberth

@roberth roberth commented May 16, 2026

Copy link
Copy Markdown
Member

Lychee by itself does not have a way to explicitly declare the intent for the site to be relocatable.
Recent-ish changes in lychee and/or its dependencies have made it catch the a root reference in all mdbook 404.html pages, which is quite confusing.
By improving the UX around this aspect of the site, we resolve at least part of that confusion.
(Though mdbook users should probably exclude the 404 page)

Things done

  • Built on platform:
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • Tested, as applicable:
  • Ran nixpkgs-review on this PR. See nixpkgs-review usage.
  • Tested basic functionality of all binary files, usually in ./result/bin/.
  • Nixpkgs Release Notes
    • Package update: when the change is major or breaking.
  • NixOS Release Notes
    • Module addition: when adding a new NixOS module.
    • Module update: when the change is significant.
  • Fits CONTRIBUTING.md, pkgs/README.md, maintainers/README.md and other READMEs.

Lychee by itself does not have a way to explicitly declare the
intent for the site to be relocatable.
Recent-ish changes in lychee and/or its dependencies have made
it catch the a root reference in all mdbook 404.html pages,
which is quite confusing.
By improving the UX around this aspect of the site, we resolve
at least part of that confusion.
(Though mdbook users should probably exclude the 404 page)
@roberth roberth force-pushed the lychee-link-check-relocatable branch from bbbe5b5 to fb0d18e Compare May 16, 2026 10:35
@nixpkgs-ci nixpkgs-ci Bot requested review from philiptaron, totoroot and tuxinaut May 16, 2026 10:40
@nixpkgs-ci nixpkgs-ci Bot added 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 6.topic: testing Tooling for automated testing of packages and modules 8.has: documentation This PR adds or changes documentation labels May 16, 2026
@totoroot

totoroot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

nixpkgs-review result

Generated using nixpkgs-review.

Command: nixpkgs-review pr 520792
Commit: fb0d18ee0b5cff8781c9271772d10d40cabb10e1


aarch64-darwin

✅ 5 packages built:
  • nixpkgs-manual
  • tests.testers.lycheeLinkCheck.fail
  • tests.testers.lycheeLinkCheck.fail-emptyDirectory
  • tests.testers.lycheeLinkCheck.fail-rootRelative
  • tests.testers.lycheeLinkCheck.ok

@totoroot totoroot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, for the late review. Thanks @roberth!
Changes look good to me. Makes the link failure a lot clearer.

@nixpkgs-ci nixpkgs-ci Bot added 12.approvals: 1 This PR was reviewed and approved by one person. 12.approved-by: package-maintainer This PR was reviewed and approved by a maintainer listed in any of the changed packages. labels Jun 8, 2026
@philiptaron philiptaron added this pull request to the merge queue Jun 10, 2026
@nixpkgs-ci nixpkgs-ci Bot added 12.approvals: 2 This PR was reviewed and approved by two persons. and removed 12.approvals: 1 This PR was reviewed and approved by one person. labels Jun 10, 2026
Merged via the queue into NixOS:master with commit 4c9924c Jun 10, 2026
38 of 40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.topic: testing Tooling for automated testing of packages and modules 8.has: documentation This PR adds or changes documentation 10.rebuild-darwin: 1-10 This PR causes between 1 and 10 packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. 12.approvals: 2 This PR was reviewed and approved by two persons. 12.approved-by: package-maintainer This PR was reviewed and approved by a maintainer listed in any of the changed packages.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants