mdbook: fix support for external repositories - #4027
Merged
UebelAndre merged 1 commit intoMay 14, 2026
Conversation
When any part of an mdbook target (either the book.toml or the source files) comes from an external repository, the build was failing because the rule's staging logic and its invocation logic handled repository boundaries inconsistently. This change: - Updates _map_inputs in mdbook.bzl to map external repository paths to 'external/' instead of '../'. - Hardens the process wrapper with a bounds check to ensure files are not staged outside the shadow work directory. - Adds an integration test to verify the fix and prevent regressions.
Contributor
Author
Please note that I don't know what the idiomatic way to handle such things are. Gemini came up with this and it seems to work based on its new test. |
UebelAndre
self-requested a review
May 13, 2026 15:38
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
May 13, 2026
mgeisler
added a commit
to mgeisler/rules_rust
that referenced
this pull request
Jun 6, 2026
…dencies This is a follow-up to bazelbuild#4027. While bazelbuild#4027 enabled the staging of files from external repositories, mdBook still requires all configuration, source files, and themes to sit in a contiguous directory structure. This change implements path flattening for both build and serve actions: - Build Action: Strips repository and package prefixes during workdir staging in mdbook.bzl. - Serve Action: Implements conditional staging in server.rs. If files are split across repositories, it flattens them into a temporary directory using symlinks to preserve live-reloading. Standard books run in-place for maximum plugin compatibility. Includes a new integration test in test/flattening that verifies resolution across three different packages, and unit tests in private/server.rs for the staging logic.
mgeisler
added a commit
to mgeisler/rules_rust
that referenced
this pull request
Jun 10, 2026
…dencies This is a follow-up to bazelbuild#4027. While bazelbuild#4027 enabled the staging of files from external repositories, mdBook still requires all configuration, source files, and themes to sit in a contiguous directory structure. This change implements path flattening for both build and serve actions: - Build Action: Strips repository and package prefixes during workdir staging in mdbook.bzl. - Serve Action: Implements conditional staging in server.rs. If files are split across repositories, it flattens them into a temporary directory using symlinks to preserve live-reloading. Standard books run in-place for maximum plugin compatibility. Includes a new integration test in test/flattening that verifies resolution across three different packages, and unit tests in private/server.rs for the staging logic.
mgeisler
added a commit
to mgeisler/rules_rust
that referenced
this pull request
Jun 10, 2026
…dencies This is a follow-up to bazelbuild#4027. While bazelbuild#4027 enabled the staging of files from external repositories, mdBook still requires all configuration, source files, and themes to sit in a contiguous directory structure. This change implements path flattening for both build and serve actions: - Build Action: Strips repository and package prefixes during workdir staging in mdbook.bzl. - Serve Action: Implements conditional staging in server.rs. If files are split across repositories, it flattens them into a temporary directory using symlinks to preserve live-reloading. Standard books run in-place for maximum plugin compatibility. Includes a new integration test in test/flattening that verifies resolution across three different packages, and unit tests in private/server.rs for the staging logic.
mgeisler
added a commit
to mgeisler/rules_rust
that referenced
this pull request
Jun 10, 2026
…dencies This is a follow-up to bazelbuild#4027. While bazelbuild#4027 enabled the staging of files from external repositories, mdBook still requires all configuration, source files, and themes to sit in a contiguous directory structure. This change implements path flattening for both build and serve actions: - Build Action: Strips repository and package prefixes during workdir staging in mdbook.bzl. - Serve Action: Implements conditional staging in server.rs. If files are split across repositories, it flattens them into a temporary directory using symlinks to preserve live-reloading. Standard books run in-place for maximum plugin compatibility. Includes a new integration test in test/flattening that verifies resolution across three different packages, and unit tests in private/server.rs for the staging logic.
mgeisler
added a commit
to mgeisler/rules_rust
that referenced
this pull request
Jun 11, 2026
…dencies This is a follow-up to bazelbuild#4027. While bazelbuild#4027 enabled the staging of files from external repositories, mdBook still requires all configuration, source files, and themes to sit in a contiguous directory structure. This change implements path flattening for both build and serve actions: - Build Action: Strips repository and package prefixes during workdir staging in mdbook.bzl. - Serve Action: Implements conditional staging in server.rs. If files are split across repositories, it flattens them into a temporary directory using symlinks to preserve live-reloading. Standard books run in-place for maximum plugin compatibility. Includes a new integration test in test/flattening that verifies resolution across three different packages, and unit tests in private/server.rs for the staging logic.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When any part of an
mdbooktarget (either thebook.tomlor the source files) comes from an external repository, the build was failing because the rule's staging logic and its invocation logic handled repository boundaries inconsistently.This change:
_map_inputsinmdbook.bzlto map external repository paths to'external/'instead of'../'.Made by Gemini, fixes #4026.