Skip to content

Commit

Permalink
docs(RELEASE_MANAGEMENT): explain auto-merge for release PRs is a no-no
Browse files Browse the repository at this point in the history
The detailed explanation is here:

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.

Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
  • Loading branch information
petermetz committed Jun 19, 2024
1 parent 0cfeffe commit fa6cb10
Showing 1 changed file with 8 additions and 0 deletions.
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

0 comments on commit fa6cb10

Please sign in to comment.