docs: release-process accuracy (workflow_dispatch ref + merge-style + version scheme) - #173
Merged
Merged
Conversation
added 3 commits
July 29, 2026 16:06
…commit) Both checkout actions (build + build-macos jobs) had no ref:, so a manual workflow_dispatch checked out the default branch (master-tip) while the release job labeled artifacts with inputs.version -> binaries labeled as a version they were not built from (#161-class mismatch). Pin ref so dispatch builds refs/tags/<inputs.version>; on tag push github.ref is already the tag, unchanged.
Feature->develop uses merge commits (--merge), not squash (git log is full of 'Merge pull request #N'); only develop->master release PRs are squash. Also update the Version-bumps rule: patch now auto-bumps +1 on every PR merged to develop via .github/workflows/bump-develop.yml (shipped in #171); minor stays manual at release via bump-version.sh --type minor (resets patch->0).
The 'pre-commit hook auto-bumps patch per commit on feature branches' claim was doubly wrong: the hook runs cargo fmt only (auto-bump was deliberately removed), and patch auto-bumping now happens via CI on PR-merge-to-develop (bump-develop.yml). Rewrote line 7 to describe the actual semver scheme; bumped _Last updated_ to 2026-07-29.
flupkede
pushed a commit
that referenced
this pull request
Jul 29, 2026
This was referenced Jul 29, 2026
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
1 participant
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.
Three release/versioning-process accuracy fixes, the follow-ups flagged after #171 (auto patch-bump workflow) shipped.
1. release.yml — pin checkout ref (functional, ~#161)
Both
actions/checkoutsteps (build + build-macos jobs) had noref:. Onworkflow_dispatchthe action checks out the repo default branch (master-tip), but the release job labels the GitHub Release/artifacts withinputs.version-> you publish binaries labeled as a version they were not built from. Nowref:resolves torefs/tags/<inputs.version>on dispatch; on tag pushgithub.refis already the tag, unchanged.2. RELEASING.md — correct merge style + version scheme
--merge), NOT squash — the doc said 'Squash merge' (line 36 + line 64). Only develop->master release PRs are squash.bump-version.sh --type minor, resets patch->0). No longer claims 'no auto-bump'.3. AGENTS.md — fix stale auto-bump claim
Line 7 claimed the pre-commit hook auto-bumps patch per commit on feature branches — doubly wrong (hook does
cargo fmtonly; auto-bump is now CI on PR-merge). Rewrote to the actual scheme; bumped the doc date.Validation: release.yml YAML re-parses (yaml.safe_load). No Rust touched -> no cargo needed.
Out of scope (separate reconcile): AGENTS.md still lists the two locked items (find_impact routing, TypeScript SCIP) as open in
## Open TODOsthough both are merged (#163, #167). Not touched here.