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

[chore] Add CI check to enforce merge freezes #11744

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jade-guiton-dd
Copy link
Contributor

@jade-guiton-dd jade-guiton-dd commented Nov 25, 2024

Description

As stated in the Release Procedure document, all merging in Core should be halted while the "Prepare release" PR is open. This PR adds a CI job checking the existence of such a PR, allowing us to enforce these freezes automatically.

To make things simple, I decided to distinguish the "Prepare release" PR from others by using a new prepare:merge-freeze label. I modified the "Prepare release" action to include that label on the automatically created PR, but in rare cases where maintainers might create the PR themselves, the label can be added manually. Triagers will need to be careful not to accidentally add this label to any random PR to avoid artificial freezes.

Because, in the current state, this CI check is run on each commit of a PR, and at no other time, there is a chance for:

  • False positives: If a commit is pushed during a freeze, and the freeze is later rescinded, the PR will remain unmergeable until a new commit is pushed. A simple solution is to re-run the check manually.
  • False negatives: If a commit is pushed outside of a freeze, then a freeze is enacted, the PR will remain mergeable despite the freeze. This is more problematic.

To solve this second problem and make this check truly useful, two changes in the repository configuration are necessary:

  • the merge queue should be enabled, allowing us to run checks again just before merging;
  • this new CI check should be added to the list of required checks for the main branch.

This will allow us to automatically cancel the merging of PRs during a freeze. A later PR on the community repository should take care of these configuration changes.

Note that another solution to handle outdated CI checks would be to use a tool like MergeFreeze, but reading this document, it sounds like it would be a harder sell with the community than enabling the merge queue.

Link to tracking issue

Updates #11707

Testing

Simple tests were made on a separate repository to check that enabling the merge queue fixes the false negatives.

Copy link

codecov bot commented Nov 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.54%. Comparing base (f74890a) to head (bc23717).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11744      +/-   ##
==========================================
- Coverage   91.61%   91.54%   -0.07%     
==========================================
  Files         443      443              
  Lines       23770    23764       -6     
==========================================
- Hits        21776    21754      -22     
- Misses       1620     1637      +17     
+ Partials      374      373       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jade-guiton-dd jade-guiton-dd marked this pull request as ready for review November 25, 2024 16:40
@jade-guiton-dd jade-guiton-dd requested a review from a team as a code owner November 25, 2024 16:40
.github/workflows/check-merge-freeze.yml Outdated Show resolved Hide resolved
.github/workflows/check-merge-freeze.yml Outdated Show resolved Hide resolved
.github/workflows/scripts/release-prepare-release.sh Outdated Show resolved Hide resolved
.github/workflows/scripts/check-merge-freeze.sh Outdated Show resolved Hide resolved
@mx-psi
Copy link
Member

mx-psi commented Nov 26, 2024

False positives: If a commit is pushed during a freeze, and the freeze is later rescinded, the PR will remain unmergeable until a new commit is pushed. A simple solution is to re-run the check manually.

As I understand it this problem remains even after we make the repository changes. Should we explicitly encourage re-running the check in the error message so that people know how to deal with false positives?

@jade-guiton-dd
Copy link
Contributor Author

jade-guiton-dd commented Nov 26, 2024

As I understand it this problem remains even after we make the repository changes. Should we explicitly encourage re-running the check in the error message so that people know how to deal with false positives?

That's probably a good idea.

@jade-guiton-dd
Copy link
Contributor Author

I went with release:merge-freeze for the triggering label in the end.

.github/workflows/check-merge-freeze.yml Outdated Show resolved Hide resolved
@mx-psi
Copy link
Member

mx-psi commented Nov 26, 2024

@open-telemetry/collector-approvers This adds a check to prevent merging other PRs during merge freezes (step 3 of the release process), which will be more useful after we have a merge queue on this repository. I will merge this on Thursday EU morning unless somebody objects before then.

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.

2 participants