Document non-squash release back-merge procedure (#226)#284
Merged
Conversation
Qodo reviews are paused for this user.Troubleshooting steps vary by plan Learn more → On a Teams plan? Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center? |
Closes #226 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
dbcf9f8 to
24261dd
Compare
This file contains hidden or 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
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.
Summary
Documents the correct release procedure in
CONTRIBUTING.mdto fix the recurring history-divergence problem described in #226.Root cause:
develop→mainand back-merges were previously squash-merged. Squash collapses the merge, so the release commit and the bot'sPackage.swiftcommit onmainnever become ancestors ofdevelop. Each release leavesmain"ahead" and periodically requires manual reconciliation.Solution (Approach A — linear
develop, real merge intomain):develop→mainis performed with a real merge commit (git merge --no-ff develop, pushed directly —mainhas no ruleset). This makes alldevelopcommits ancestors ofmain; history no longer diverges.main→developstays a squash-PR (next-SNAPSHOTbump +Package.swiftsync), sodevelopremains linear and therequired_linear_historyruleset is untouched.No code/CI/GitHub-settings changes — documentation only.
Changes to
CONTRIBUTING.mddevelop→ real merge intomain→ tag → back-merge squash-PR).publish.yml:Package.swiftbot commit lands directly inmainonv*tag push.workflow_dispatch.USER_MANAGED(manual promote in Portal UI).develop, notmain.Verification
Pure documentation edit — build/test gates inapplicable (
spotlesscovers only.kt/.kts). Reviewed for internal consistency and againstpublish.ymlfacts; the documentedgit merge --no-ff+ direct push tomainis valid under main's empty ruleset, and the flow does not violaterequired_linear_historyondevelop(back-merge = squash-PR).🤖 Generated with Claude Code