Skip to content

Remove mdbook-linkcheck#684

Merged
BD103 merged 2 commits into
mainfrom
remove-linkcheck
Nov 22, 2025
Merged

Remove mdbook-linkcheck#684
BD103 merged 2 commits into
mainfrom
remove-linkcheck

Conversation

@DaAlbrecht
Copy link
Copy Markdown
Collaborator

mdbook-linkcheck breaks currently in our CI:

0s
Run mdbook build
 INFO Book building has started
 INFO Running the html backend
 INFO HTML book written to `/home/runner/work/bevy_cli/bevy_cli/docs/book/html`
 INFO Running the linkcheck backend
 INFO Invoking the "linkcheck" renderer
Error: Unable to parse RenderContext

Caused by:
    missing field `sections` at line 1 column 123841
ERROR Renderer exited with non-zero return code.
ERROR Rendering failed
	Caused by: The "linkcheck" renderer failed
Error: Process completed with exit code 101.
Run mdbook build
 INFO Book building has started
 INFO Running the html backend
 INFO HTML book written to `/home/runner/work/bevy_cli/bevy_cli/docs/book/html`
 INFO Running the linkcheck backend
 INFO Invoking the "linkcheck" renderer
Error: Unable to parse RenderContext

Caused by:
    missing field `sections` at line 1 column 123841
ERROR Renderer exited with non-zero return code.
ERROR Rendering failed
	Caused by: The "linkcheck" renderer failed

https://github.com/TheBevyFlock/bevy_cli/actions/runs/19582097130/job/56082307183

I think this is due to a new mdbook version that is no longer compatible with mdbook-linkcheck.

The Project does not really seem to be maintained anymore, so I would like to remove it.

@DaAlbrecht DaAlbrecht added A-Build-System Related to CI and GitHub Actions C-Docs An improvement in documentation D-Trivial Nice and easy! A great choice to get started with Bevy CLI S-Needs-Review The PR needs to be reviewed before it can be merged labels Nov 22, 2025
@BD103
Copy link
Copy Markdown
Member

BD103 commented Nov 22, 2025

Looking at the error message, I bet we're hitting the breaking change introduced in rust-lang/mdBook#2813 that comes with the newly-released mdbook v0.5. I'm happy to remove mdbook-linkcheck, as you mentioned it's not maintained!

In the future I'd like to look into adding mdbook-linkcheck2, a maintained fork that hopefully will add support for v0.5 once marxin/mdbook-linkcheck2#8 is merged. It looks like the Rust Forge and rustc Dev Guide will be switching to it as well, so I'm happy to follow them. :)

@BD103 BD103 merged commit 98527ff into main Nov 22, 2025
10 checks passed
@BD103 BD103 deleted the remove-linkcheck branch November 22, 2025 21:53
@marxin
Copy link
Copy Markdown

marxin commented Nov 23, 2025

In the future I'd like to look into adding mdbook-linkcheck2

I've just made the release, please test it.

@DaAlbrecht
Copy link
Copy Markdown
Collaborator Author

In the future I'd like to look into adding mdbook-linkcheck2

I've just made the release, please test it.

Hey thank you so much!

I tested this with our previous config here: #685

But the exclude list seems not to work as it used to?

We exclude: exclude = ["/api/bevy_lint"]

❯ mdbook build
 INFO Book building has started
 INFO Running the html backend
 INFO HTML book written to `/home/squishy/bevy_org/bevy_cli/docs/book/html`
 INFO Running the linkcheck2 backend
 INFO Invoking the "linkcheck2" renderer
error: File not found: ../api/bevy_lint/lints/index.html
  ┌─ linter/index.md:5:3
  │
5 │ - [**All Lints**](../api/bevy_lint/lints/index.html)
  │   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File not found: ../api/bevy_lint/lints/index.html

error: File not found: ../../../api/bevy_lint/lints/index.html
  ┌─ contribute/linter/reference/lint-module-docs.md:3:12
  │
3 │ All lints, [which can be found here](../../../api/bevy_lint/lints/index.html), place their documentation in their module. For example, `missing_reflect`'s docs are in `src/lints/missing_reflect.rs`. These docs must adhere to the following format:
  │            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File not found: ../../../api/bevy_lint/lints/index.html

Error: One or more incorrect links
ERROR Renderer exited with non-zero return code.
ERROR Rendering failed
        Caused by: The "linkcheck2" renderer failed

@marxin
Copy link
Copy Markdown

marxin commented Nov 23, 2025

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

Labels

A-Build-System Related to CI and GitHub Actions C-Docs An improvement in documentation D-Trivial Nice and easy! A great choice to get started with Bevy CLI S-Needs-Review The PR needs to be reviewed before it can be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants