fix(docs): correct sync-dev-after-release docs to match PR-based flow#29
Merged
Merged
Conversation
PR #28 refactored `scripts/sync-dev-after-release.sh` from direct-commit-to-dev to PR-based flow (cuts a `chore/sync-dev-after-vX.Y.Z` branch and opens a PR), but the accompanying documentation in `RELEASES.md` and `RELEASES-RATIONALE.md` still describes the old direct-commit shape. Bring both docs in sync with the shipped script. `RELEASES.md` § "After publish — sync dev with the release": - Replace "commits the result directly to `dev` as one signed commit (no PR)" with "cuts a `chore/sync-dev-after-vX.Y.Z` branch off `dev` and opens a PR". - Add a pointer to the rationale section explaining the PR-only norm applies here too. - Update the idempotency line from "exits 0 with no commit" to "exits 0 without creating a branch or PR" to match the script's actual short-circuit behaviour. `RELEASES-RATIONALE.md` § "Why backport `main` -> `dev` after publish": - Replace the "lands directly on `dev` (one signed commit, no PR). This is a deliberate exception to the PR-only norm" paragraph with the current behaviour: the backport opens a PR, the PR-only norm applies, the mechanical-diff and idempotency arguments justify reviewer spot-check + squash-merge rather than the prior exception-from-norm framing. - Same idempotency-line correction as RELEASES.md. No script changes; this PR only updates the prose that lagged the script.
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
PR #28 refactored
scripts/sync-dev-after-release.shfrom direct-commit-to-dev to PR-based flow (cuts achore/sync-dev-after-vX.Y.Zbranch and opens a PR), but the accompanying documentation inRELEASES.mdandRELEASES-RATIONALE.mdstill describes the old direct-commit shape. Bring both docs in sync with the shipped script.No script changes; this PR only updates the prose that lagged the script.
What changed in
RELEASES.md§ "After publish — sync dev with the release"devas one signed commit (no PR)" with "cuts achore/sync-dev-after-vX.Y.Zbranch offdevand opens a PR".What changed in
RELEASES-RATIONALE.md§ "Why backport main → dev after publish"dev(one signed commit, no PR). This is a deliberate exception to the PR-only norm" paragraph with the current behavior: the backport opens a PR, the PR-only norm applies, the mechanical-diff and idempotency arguments justify reviewer spot-check + squash-merge rather than the prior exception-from-norm framing.Changelog
Fixed
RELEASES.mdandRELEASES-RATIONALE.mdcorrected to reflect the PR-based dev-sync flow thatscripts/sync-dev-after-release.shhas shipped since PR chore(release): refactor sync-dev-after-release.sh to PR-based flow #28. The previous text claimed the backport lands directly ondevas one signed commit; the script actually cuts achore/sync-dev-after-vX.Y.Zbranch and opens a PR.Type of Change
fix: Bug fix (non-breaking change which fixes an issue)Related Issues/Stories
brettdavies/agent-skillsPR release: v0.2.0 — agent-native CLI skill bundle public launch #12, which lands the same documentation (RELEASES.md + RELEASES-RATIONALE.md + RELEASES-PREFLIGHT.md triad) into the canonicalgithub-repo-setupskill template with the corrected PR-based wording from day one.Testing
Test Summary:
markdownlint-cli2 RELEASES.md RELEASES-RATIONALE.mdclean on both files.Files Modified
Modified:
RELEASES.mdRELEASES-RATIONALE.mdBreaking Changes
Deployment Notes
This is a docs-only fix. After merge to
dev, the file changes will sit ondevuntil the nextrelease/* → maincherry-pick brings them ontomain(per RELEASES.md's branching model).Checklist