Skip to content

ci: use mdbook-linkcheck2 #67

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
Wenzel merged 1 commit into from
Jan 15, 2026
Merged

ci: use mdbook-linkcheck2 #67

Wenzel merged 1 commit into from
Jan 15, 2026
+1 −1

Conversation

@Wenzel
Copy link
Contributor

@Wenzel Wenzel commented Jan 15, 2026

Should fix

Run pushd docs || exit 1
  pushd docs || exit 1
  mdbook build
  popd || exit 1
  shell: /usr/bin/bash -e {0}
  env:
    PUBLIC_SIMICS_PKGS_URL: https://registrationcenter-download.intel.com/akdlm/IRC_NAS/ead79ef5-28b5-48c7-8d1f-3cde7760798f/simics-6-packages-2024-05-linux64.ispm
    PUBLIC_SIMICS_ISPM_URL: https://registrationcenter-download.intel.com/akdlm/IRC_NAS/ead79ef5-28b5-48c7-8d1f-3cde7760798f/intel-simics-package-manager-1.8.3-linux64.tar.gz
    PUBLIC_SIMICS_PACKAGE_VERSION_1000: 6.0.185
    CARGO_HOME: /home/runner/.cargo
    CARGO_INCREMENTAL: 0
    CARGO_TERM_COLOR: always
~/work/simulator-bindings/simulator-bindings/docs ~/work/simulator-bindings/simulator-bindings
 INFO Book building has started
 INFO Running the html backend
 INFO HTML book written to `/home/runner/work/simulator-bindings/simulator-bindings/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 17868
ERROR Renderer exited with non-zero return code.
ERROR Rendering failed
	Caused by: The "linkcheck" renderer failed

@Wenzel Wenzel requested a review from Copilot January 15, 2026 15:58
Copilot AI reviewed Jan 15, 2026
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the mdBook linkcheck plugin from mdbook-linkcheck to mdbook-linkcheck2 to resolve a rendering error caused by a missing sections field in the RenderContext.

Changes:

  • Updated the CI workflow to install mdbook-linkcheck2 instead of mdbook-linkcheck

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Wenzel Wenzel merged commit 2f8bd81 into main Jan 15, 2026
5 checks passed
@Wenzel Wenzel deleted the ci/fix_docs branch January 15, 2026 16:34
@Wenzel Wenzel mentioned this pull request Jan 16, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Wenzel