preprocess/links: fail for invalid links #2277
Open
Conversation
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
Before, `mdbook` would continue processing even when errors, such as invalid links, are encountered. Moreover, it would exit with a `0` return code. Such behavior is unexpected and leads to confusion when run in CI. Now, when links that don't point to existing files are encounter and error is returned which yields to `mdbook` exiting with an error code. The change in behavior has revealed that some tests were run with invalid links.
|
Took this branch for a spin, and worked well: my existing mdbook docroot with broken links threw an error, as I'd expected. After patching the include, no more errors. I support this change being merged. |
This was referenced Dec 14, 2024
|
Hi 👋 , will this be merged? |
github-merge-queue bot
pushed a commit
to foundry-rs/starknet-foundry
that referenced
this pull request
Dec 17, 2024
<!-- Reference any GitHub issues resolved by this PR --> Closes #2756 ## Introduced changes <!-- A brief description of the changes --> Add a script which exits with code 1 in case when there are errors when running `mdbook build`. This should be ofc done on mdbook's project side, however it hasn't been addressed yet (rust-lang/mdBook#2277). Example run with broken docs url: https://github.com/foundry-rs/starknet-foundry/actions/runs/12329947653/job/34414855443 ## Checklist <!-- Make sure all of these are complete --> - [x] Linked relevant issue - [x] Updated relevant documentation - [x] Added relevant tests - [x] Performed self-review of the code - [x] Added changes to `CHANGELOG.md`
heyitsaamir
added a commit
to microsoft/teams-ai
that referenced
this pull request
Apr 25, 2025
- Adds some dialog docs (in conjunction with dialog samples microsoft/teams.ts#175) - Our mdbook build/serve step wasn't failing if links were broken. The error would be printed, but it wouldn't fail. rust-lang/mdBook#2277. I improved the script so that it watched for the `[ERROR]` string and failed if it saw it.
|
☔ The latest upstream changes (possibly #2681) made this pull request unmergeable. Please resolve the merge conflicts. |
|
Thank you @rustbot. Because the maintainer has ignored this PR even though he has acknowledged the issue I have little motivation to put more effort in vain. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Before,
mdbookwould continue processing even when errors, such as invalid links, are encountered. Moreover, it would exit with a0return code. Such behavior is unexpected and leads to confusion when run in CI.Now, when links that don't point to existing files are encounter and error is returned which yields to
mdbookexiting with an error code. The change in behavior has revealed that some tests were run with invalid links.Closes #1094