Skip to content

CI: add mdbook test to validate guide in PRs#2711

Open
benhillis wants to merge 2 commits intomicrosoft:mainfrom
benhillis:mdbook_test
Open

CI: add mdbook test to validate guide in PRs#2711
benhillis wants to merge 2 commits intomicrosoft:mainfrom
benhillis:mdbook_test

Conversation

@benhillis
Copy link
Member

This change ensures that code samples in the rust code samples compile and fixes any current issues preventing mdbook test from currently passing.

@benhillis benhillis requested a review from a team as a code owner January 29, 2026 23:57
Copilot AI review requested due to automatic review settings January 29, 2026 23:57
@github-actions github-actions bot added the Guide label Jan 29, 2026
Copy link
Contributor

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 adds mdbook test to the CI build process to validate that Rust code examples in the guide compile correctly. It also marks several flowey-related code snippets with rust,ignore to exclude them from compilation testing, and removes a redundant configuration setting from book.toml.

Changes:

  • Added mdbook test command to build_guide.rs to validate code examples during guide builds
  • Marked incomplete code snippets in flowey documentation files with rust,ignore attribute
  • Removed redundant multilingual = false setting from book.toml (it's the default value)

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
flowey/flowey_lib_hvlite/src/build_guide.rs Added mdbook test command and refactored environment variable setup
Guide/src/dev_guide/dev_tools/flowey/variables.md Marked code snippets with rust,ignore
Guide/src/dev_guide/dev_tools/flowey/steps.md Marked code snippets with rust,ignore
Guide/src/dev_guide/dev_tools/flowey/pipelines.md Marked code snippets with rust,ignore
Guide/src/dev_guide/dev_tools/flowey/nodes.md Marked code snippets with rust,ignore
Guide/src/dev_guide/dev_tools/flowey/artifacts.md Marked code snippets with rust,ignore
Guide/book.toml Removed redundant default configuration value

@github-actions
Copy link

github-actions bot commented Feb 5, 2026

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants