Repository navigation
Build pull requests, and fail on broken anchors - #5
Merged
Merged
Conversation
Nothing ran on a PR here: the only workflow deploys on push to main, so a change was verified after it was already in production. The last merge went out that way. For a Docusaurus site the build is the test suite, so the gate is just the build. Broken anchors only warned, which made it a weak one — the docs now link between sections enough for that to matter.
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
1 participant
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.
Nothing ran on a pull request in this repository: the only workflow deploys on push to main, so a change was verified after it was already in production. The previous merge went out that way, and the site build is the one check that would have caught the MDX failure hit while writing it.
For a Docusaurus site that build is effectively the test suite — broken links, broken anchors and MDX compilation errors all fail it — so the new workflow just runs it. Broken anchors were only warning, which made the gate weaker than it looks now that the docs cross-link between sections; they throw as links already did. The current tree passes with that on.
Mirrors the arrangement in the app repository, where a PR workflow runs the suite and the deploy workflow runs it again on main.