ci: trigger docs build on changes to build inputs#1967
Merged
holtskinner merged 1 commit intoJun 22, 2026
Conversation
The Docs Build and Deploy workflow only ran when docs/**, mkdocs.yml, requirements-docs.txt, or the workflow itself changed. But the rendered site also depends on: - .mkdocs/** - the macros module (.mkdocs/macros) and theme overrides (.mkdocs/overrides) referenced by mkdocs.yml - specification/a2a.proto - source for the proto_to_table macros - scripts/build_docs.sh - the build entrypoint the workflow invokes Changes to these could break the build or alter every rendered page without triggering CI (e.g. the macros.py anchor fix in a2aproject#1966 ran no build check). Add them to the push and pull_request path filters.
Contributor
|
Note Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported. |
holtskinner
approved these changes
Jun 22, 2026
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.
Summary
Fixes #1968.
The Docs Build and Deploy workflow (
.github/workflows/docs.yml) only triggers whendocs/**,mkdocs.yml,requirements-docs.txt, or the workflow file change. But the rendered site also depends on inputs that are not in the path filter:.mkdocs/**— the macros module (.mkdocs/macros) and theme overrides (.mkdocs/overrides), both referenced frommkdocs.ymlspecification/a2a.proto— the source theproto_to_table/proto_service_to_tablemacros parse to generate the API tablesscripts/build_docs.sh— the build entrypoint the workflow actually runsA change to any of these can break the build or alter every rendered page while CI stays green. Concrete example: the macros anchor fix in #1966 changes rendering logic for the whole spec, yet
build_and_deploynever ran on it because.mkdocs/**wasn't watched.Change
Add
.mkdocs/**,specification/a2a.proto, andscripts/build_docs.shto both thepushandpull_requestpath filters. No behavioral change to the build itself — it just runs in more of the cases where it should.Verification
docs.ymlparses as valid YAML.paths:blocks updated identically.mkdocs.yml(custom_dir: .mkdocs/overrides,module_name: .mkdocs/macros) andscripts/build_docs.sh(readsspecification/a2a.proto).docs.ymltriggeredbuild_and_deploy, which previously would not run for a.mkdocs/-only change.