Cherrypick ci improvements to 2.13.x #16065
Merged
Conversation
This file contains 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
- Refactor out the per-platform job generation. - Ensure names are properly platform-qualified. - Add a "Merge OK" job that depends on all the other jobs, so that branch protection only needs to know about that one, instead of an ever changing list of job names. - Inject the dep on check_labels automatically, and only in PR jobs (cron-triggered jobs don't need this).
A new job detects whether the change is "docs only", and all the other jobs run only if "docs only" is false. The complication is that we have a branch protection rule on main that prevents merges unless a CI job named "Merge OK" passes. Today that job depends on all the other jobs (running tests etc.) and if we skip those jobs, the "Merge OK" job will not run and so we won't be able to merge. Therefore we generate two "Merge OK" jobs: one that depends on all the checks but runs only if "docs only" is false, and another that runs with no other dependencies, but only if "docs only" is true. Note that we cannot implement this using GitHub Action's path filtering, because that provides only "run a workflow if any path is under a dir" or "skip a workflow if all paths are under a dir". It does not provide "run a workflow if all paths are under a dir", which is what we'd need for the "Merge OK" logic above.
…build#16053) The previous solution involved some complexity in extracting the filenames from JSON, and was not robust to spaces in path names (we do have such paths under docs/). Instead we use a different GHA marketplace action. This one is more featureful, and allows us to specify a subset of files to look at, so we don't need to do the filtering ourselves. We can just check if the filtered set (everything except docs/**) has any changes in it.
|
It would be harder to do the same for 2.12 as that is further behind. But we are unlikely to apply many docs changes to 2.12 at this point, whereas 2.13 is going to be the active docs version for a while. |
Eric-Arellano
approved these changes
Jul 5, 2022
Merged
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.
Cherrypicks the recent changes to the CI script generator, so that docs-only changes
that are cherry-picked to 2.13 don't force a full CI there.