Skip to content

Commit 1dc44e2

Browse files
committed
docs: align bump policy and docs-bump cadence
1 parent 76d3272 commit 1dc44e2

7 files changed

Lines changed: 33 additions & 17 deletions

File tree

.agents/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ Last updated: 2026-04-09
2121
- Follow the response option framing in `AGENTS.md`.
2222
- When presenting a minimal implementation path, also offer to provide `recommended` and `full` options with clear scope and tradeoffs.
2323

24+
## Docs bump cadence
25+
- If the current branch already includes a docs bump/version entry, rerun docs-bump checks after each meaningful change to avoid missing version/changelog drift.
26+
2427
## Work snapshot guidance
2528
- Local handoff file: `.agents/work-snapshot.local.md`.
2629
- Read it at session start when present to recover intent/next steps.

.agents/skills/update-changelog/SKILL.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,13 @@ Update the current version changelog entry without changing the version.
4040
3. If the version exists in branch changelog (including when it is not yet merged to `main`), update that same entry in place.
4141
4. If branch entry is missing but `main` already has that version entry, cherry-pick/recreate that entry at the top and then update it.
4242
5. If branch and `main` both lack that version entry, stop and run [Version Bump Skill](../version-bump/SKILL.md).
43-
6. Consolidate the entry before finalizing: merge overlapping bullets, collapse low-level implementation-only bullets into higher-level outcomes, and remove duplicates.
44-
7. Update Added/Changed/Fixed bullets with concise, user-visible or contributor-impacting changes; keep style and tense consistent.
45-
8. When updating an existing entry, keep the version unchanged and set the entry date to today's date (`YYYY-MM-DD`, UTC).
46-
9. If adding more changes later without bumping a new version, update that same entry again (rewrite/refine, not append-only) and refresh the date to today's date.
47-
10. Validate with `git diff`; run tests if code changed.
43+
6. If this PR branch already contains one bump, keep reusing that entry for subsequent commits; do not create another version header unless explicitly requested.
44+
7. Consolidate the entry before finalizing: merge overlapping bullets, collapse low-level implementation-only bullets into higher-level outcomes, and remove duplicates.
45+
8. Update Added/Changed/Fixed bullets with concise, user-visible or contributor-impacting changes; keep style and tense consistent.
46+
9. When updating an existing entry, keep the version unchanged and set the entry date to today's date (`YYYY-MM-DD`, UTC).
47+
10. If adding more changes later without bumping a new version, update that same entry again (rewrite/refine, not append-only) and refresh the date to today's date.
48+
11. Validate with `git diff`; run tests if code changed.
49+
12. If this branch already has a docs bump/current-version entry, rerun docs-bump checks after each meaningful change to catch version/changelog drift early.
4850

4951
## Outputs
5052
- Updated `CHANGELOG.md` entry for the current version reflecting all new work.

.agents/skills/version-bump/SKILL.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ Keep the BasicSetup CLI version and changelog in sync for releases.
1616
- Automated bumps (e.g., Dependabot) are not handling this branch.
1717
- For changelog-only edits after a bump, use [Update Changelog Skill](../update-changelog/SKILL.md).
1818

19+
## Precedence rules
20+
- Default to one version bump per PR branch.
21+
- After a branch has been bumped, do not bump again for follow-up commits unless the user explicitly requests another bump or release policy requires it.
22+
- For follow-up commits on the same PR, update the existing current-version changelog entry via [Update Changelog Skill](../update-changelog/SKILL.md).
23+
- If a docs bump is already present on the branch, rerun docs-bump checks after each meaningful change.
24+
1925
## Prerequisites
2026
- Tools: `yq`, `git`, `make` (for tests when code changes are included).
2127
- Permissions to push branch changes.
@@ -34,6 +40,12 @@ Keep the BasicSetup CLI version and changelog in sync for releases.
3440
4. Verify alignment: top changelog version matches `.BasicSetupCliVersion`; date is valid for CI validation (UTC +/- 1 day).
3541
5. Validate changes: at minimum `git diff`; run `make test` if code changed.
3642

43+
## Decision table
44+
- No bump yet on the PR branch: create a new version entry and set version files.
45+
- Branch already has a bump for this PR: do not bump again; update that same entry.
46+
- User explicitly requests another bump: create the next version.
47+
- Release policy explicitly requires another bump: create the next version and document why.
48+
3749
## Outputs
3850
- Updated `resources/version.yaml` with the new version (and mirrored `bsctl/static/resources/constants.yaml` during transition).
3951
- Matching `CHANGELOG.md` entry for `X.Y.Z`.

AGENTS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -426,8 +426,11 @@ Follow [Semantic Versioning 2.0.0](https://semver.org/):
426426
4. **Automated Bumping**
427427
- Dependabot PRs are automatically bumped via workflow
428428
- Manual PRs require manual version bump
429-
- Every MR/PR/changeset should include a version bump and matching CHANGELOG entry unless explicitly exempted
430-
- Always bump version before merging
429+
- Every MR/PR should include at least one version bump and matching CHANGELOG entry unless explicitly exempted
430+
- Default to one bump per PR branch; follow-up commits should update the existing current-version entry rather than creating another version
431+
- Only bump again on the same PR when explicitly requested by the user or required by release policy
432+
- If a docs bump is already present on the branch, rerun docs-bump checks after each meaningful change to reduce missed changelog/version drift
433+
- Always ensure the branch is bumped before merging
431434

432435
### Example CHANGELOG Entry
433436

CHANGELOG.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,6 @@
33
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
44

55

6-
---
7-
## [0.1.24] - 2026-04-09
8-
9-
### Changed
10-
11-
- Added a `Response Option Framing` standard in `AGENTS.md` requiring agents that present a minimal path to also offer `recommended` and `full` options with explicit scope/tradeoff framing.
12-
- Updated `.agents/README.md` to reference the new response-framing policy and refreshed instruction metadata date.
13-
146
---
157
## [0.1.23] - 2026-04-09
168

@@ -22,6 +14,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
2214

2315
- Updated `docs/plans/bsctl-codeql-decommission-plan.md` with Phase C status and immediate next steps for static-check validation before CodeQL re-scope/removal.
2416
- Refined static-check workflow behavior so `shellcheck`/`shfmt -d` run on `*.sh`/`*.bash` and zsh files are validated separately with `zsh -n`.
17+
- Added a `Response Option Framing` standard in `AGENTS.md` requiring agents that present a minimal path to also offer `recommended` and `full` options with explicit scope/tradeoff framing.
18+
- Updated `.agents/README.md` to reference the new response-framing policy and refreshed instruction metadata date.
19+
- Clarified versioning policy across `AGENTS.md` and changelog/version skills to default to one bump per PR and reuse the current-version entry for follow-up commits unless explicitly requested to bump again.
20+
- Added docs-bump cadence guidance across agent docs/skills: when a branch already has a docs bump, rerun docs-bump checks after each meaningful change.
2521

2622
---
2723
## [0.1.22] - 2026-04-09
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# BasicSetupCliVersion - constant for semantic versioning
2-
BasicSetupCliVersion: "0.1.24"
2+
BasicSetupCliVersion: "0.1.23"

resources/version.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# BasicSetupCliVersion - primary version source for releases and docs bump automation
2-
BasicSetupCliVersion: "0.1.24"
2+
BasicSetupCliVersion: "0.1.23"

0 commit comments

Comments
 (0)