ci: Add CI workflow to check docs build in PRs - #985
Merged
Conversation
Collaborator
Author
|
Tested with an example breakage to |
joefernandez
approved these changes
Nov 20, 2025
Collaborator
|
@koverholt - Let's monitor this closely for a few days to make sure this does not significantly impact forward movement of content updates. |
Collaborator
Author
|
@joefernandez, will do. Note that this will not block any current or future PR merges, only show up a failing test. We would need to add a ruleset to enforce this, which we don't need to do at this time. So you can consider this a "soft" CI test for PRs. |
koverholt
added a commit
to sabrenner/google-adk-docs
that referenced
this pull request
Apr 28, 2026
* Add CI workflow to check docs build in PRs * Intentionally break mkdocs.yml to check CI test * Revert intentional config breakage / test * Test CI run
koverholt
added a commit
to sabrenner/google-adk-docs
that referenced
this pull request
Apr 28, 2026
* Add CI workflow to check docs build in PRs * Intentionally break mkdocs.yml to check CI test * Revert intentional config breakage / test * Test CI run
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.
This PR adds a GitHub action / workflow to build the docs in a PR as a pass/fail check.
It runs with
mkdocs build --strictto fail on any warnings, and will ensure that a given branch / PR will not fail the docs build if merged, which could lead to silent failures until manually caught and fixed.