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

docs(RELEASE_MANAGEMENT): explain auto-merge for release PRs is a no-no #3329

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions RELEASE_MANAGEMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,14 @@ git push --set-upstream upstream release-v1.1.3

### Then create a PR here - once that's merged, rebase onto upstream/main and:

**IMPORTANT**: Do not enable auto-merging on GitHub for the pull request doing the release.
The problem with auto-merging here is that it would modify the release commit's SHA as the
rebase would happen on GitHub's servers where your git signing identity is not available to use
given that GitHub does (should) not have access to your private key for signing.
The way the preserve your commit signature as valid the commit SHA must remain the same and the
way to achieve this is to perform the pull request merging with fast forward. The merging
ensures that there is no commit SHA change and the `--ff-only` option ensures that there is no
merge commit to throw a wrench in the process.

1. Do a merge freeze
2. Unfreeze the specific pull request that you just opened for the release issuance
Expand Down
Loading