Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make Quick Checks be skipped if a PR updates only the CHANGELOG or version/VERSION files #36215

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

SarahFrench
Copy link
Member

@SarahFrench SarahFrench commented Dec 13, 2024

This PR's changes are intended to cause PRs that update CHANGELOGs and version/VERSION do not need to wait for these checks to complete.

Example PRs:

The version value is baked into the build binary, so the tests do help detect any issues stemming from bad values in version/VERSION. Because of this, this PR should be accompanied by some automation to ensure version/VERSION contains a string in the expected format.


The docs for path-ignore say that the GHA would only be skipped if the PR changes only the files listed. If the PR edits additional files then the GHA will run during checks as expected:

When all the path names match patterns in paths-ignore, the workflow will not run. If any path names do not match patterns in paths-ignore, even if some path names match the patterns, the workflow will run.

Target Release

N/A

Draft CHANGELOG entry

N/A

Comment on lines 29 to +37
push:
branches:
- '*'
tags:
- 'v[0-9]+.[0-9]+.[0-9]+*'
paths-ignore:
# Stop quick checks if the PR contains changes limited to just these files
- 'CHANGELOG.md'
- 'version/VERSION'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this stops the check running on the commit made when the PR is merged, so this PR will need to be updated with triggers specific to different subsets of branches (paths-ignore for pushes to contributors' branches, no ignoring for pushes to branches like main and vX.X.X)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant