Repository navigation
Skip CI for pull requests that only change documentation - #6127
Conversation
|
See also #6128 |
| - release-* | ||
| pull_request: | ||
| # Keep in sync with ci-docs-skip.yml | ||
| paths-ignore: |
There was a problem hiding this comment.
Remind me what you said last week - what happens when a single PR contains changes to .md files AND to code files? Would both workflows run? And then what is reported?
There was a problem hiding this comment.
It reports all steps, but they are visually separated by the workflow name
There was a problem hiding this comment.
So is it possible that the no-docs workflow could finish all steps and report everything green, and then a person could merge before the real CI started to report that steps were actually failing?
There was a problem hiding this comment.
I tested this last week, and as long as those other builds are still going on, the required status checks are not green
Co-authored-by: David Boike <david.boike@gmail.com>
|
Merging for now. We can always make tweaks or revert |
Pull requests that only change
docs/**/*.mdorAGENTS.mdno longer run CI.ci.ymlignores those paths onpull_request. Because the required checks would then stay pending, the newci-docs-skip.ymltriggers on the same paths and reports every CI check name as passed. Its job names mirrorci.yml, including the reusable-workflow names such ascontainers / servicecontrol.ci-docs-skip.ymlmust be updated whenever aci.ymljob or matrix entry changes.A pull request that changes both docs and code matches both workflows, so the shadow checks and the real checks share names. In a test with such a pull request, GitHub kept it blocked while the real jobs ran. All real and shadow checks passed once the jobs finished. A docs-only pull request ran only the shadow workflow and was mergeable.
code-analysis.ymlis unchanged and still runs on docs-only pull requests.Docs reviewed:
docs/README.md,CONTRIBUTING.md, and the other pages underdocs/. None describesci.yml, so no update is needed.