-
Notifications
You must be signed in to change notification settings - Fork 9.6k
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 on release preparation PRs. Add new version check specific to release preparation PRs. #36215
Draft
SarahFrench
wants to merge
10
commits into
main
Choose a base branch
from
skip-checks-on-changelog-version-updates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+156
−11
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
SarahFrench
commented
Dec 16, 2024
SarahFrench
added
the
no-changelog-needed
Add this to your PR if the change does not require a changelog entry
label
Feb 3, 2025
…rsion/VERSION files
…nt branches, including main
…re are no other changed files
SarahFrench
force-pushed
the
skip-checks-on-changelog-version-updates
branch
from
February 3, 2025 12:02
4e1c3b7
to
4046b84
Compare
SarahFrench
force-pushed
the
skip-checks-on-changelog-version-updates
branch
from
February 3, 2025 12:43
f446ea2
to
0cc2a18
Compare
SarahFrench
changed the title
Make Quick Checks be skipped if a PR updates only the CHANGELOG or version/VERSION files
Make Quick Checks be skipped on release preparation PRs. Add new version check specific to release preparation PRs.
Feb 3, 2025
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.
Problem
This PR's changes are intended to allows PRs made during the release process to skip running all the 'Quick Checks'.
These example PRs made during releases show how the changes are limited CHANGELOG.md, .changes/***, and version/VERSION files, so running the full test suite isn't necessary.
However the PRs should still run unit tests for the version package. This ensures the new value for
version/VERSION
is correct, which is important as the value impacts the final built binaries in a release.After these changes we need to make sure all tests still run against pushes to the main branch/important branches.
Solution
I've made the
checks.yml
workflow into a reusable workflow, and made workflow files for these different scenarios:Creating multiple workflows that reuse
checks.yml
is necessary because we cannot define multiplepush
triggers in a single workflow. Defining multiple push triggers is required to enable us to distinguish a push to protected versus non-protected branches.Also, this PR also introduces a new workflow that will run tests to check the version value is correct when a PR contains changes limited to the version package.
Ideas not in this PR
We could introduce the use of concurrency groups to avoid PRs running tests in duplicate (push and pull_request triggers). However I think that'd be useful to introduce separately, to avoid this PR being too complicated.