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 on release preparation PRs. Add new version check specific to release preparation PRs. #36215

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

Conversation

SarahFrench
Copy link
Member

@SarahFrench SarahFrench commented Dec 13, 2024

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:

  • Running checks in the context of a push to main or release branches
  • Running checks when pushing to a non-protected feature branch
  • Running checks on PRs

Creating multiple workflows that reuse checks.yml is necessary because we cannot define multiple push 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.

@SarahFrench SarahFrench added the no-changelog-needed Add this to your PR if the change does not require a changelog entry label Feb 3, 2025
@SarahFrench SarahFrench force-pushed the skip-checks-on-changelog-version-updates branch from f446ea2 to 0cc2a18 Compare February 3, 2025 12:43
@SarahFrench 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
@SarahFrench
Copy link
Member Author

SarahFrench commented Feb 3, 2025

Screenshot 2025-02-03 at 12 52 17

It looks like there are some settings on this repo that this PR affects. I believe this repo expects Quick Checks to always be present on PRs, so this PR breaks that expectation by renaming the checks and future PRs that skip Quick Checks may have merging blocked also.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog-needed Add this to your PR if the change does not require a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant