Skip to content

Commit 7c24073

Browse files
docs: correct SECURITY sync scope, grep pattern, and release notes footer
1 parent d6bc37f commit 7c24073

2 files changed

Lines changed: 6 additions & 7 deletions

File tree

RELEASING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Manual release flow for claude-code-chat-browser. A release is a git tag plus a
88

99
The release version is `__version__` in `app.py` line 3. There is no `pyproject.toml` version field.
1010

11-
`SECURITY.md` line 5 repeats that version in the supported-versions blurb. Update it whenever you bump `app.py`. `README.md` points readers at that page.
11+
`SECURITY.md` line 5 names the latest shipped release in its supported-versions blurb, so update it when a tag ships, not on the `.dev0` bumps in between. `README.md` points readers at that page.
1212

1313
Between tagged releases, `master` may use a `.dev0` suffix (for example `0.3.0.dev0` while the next release is in flight). The shipped tag drops `.dev0`.
1414

@@ -27,12 +27,12 @@ Do the changelog in one PR and the version bump in a second PR, or combine them
2727
- Leave `## [Unreleased]` empty.
2828
- Update the footer compare links: `[Unreleased]``vX.Y.Z...HEAD`, add `[X.Y.Z]``vPREVIOUS...vX.Y.Z`.
2929
2. On a branch from current `master`, set `app.py` line 3 to the release version without `.dev0` (for example `"0.2.0"`).
30-
3. Update [SECURITY.md](SECURITY.md) line 5 so the "(currently ...)" parenthetical matches that version (for example `(currently 0.2.0)`). Leave the table at lines 7-10 unchanged.
30+
3. Update [SECURITY.md](SECURITY.md) line 5 so the version inside its "(currently ...)" parenthetical is the one you are shipping. Keep the surrounding formatting and leave the table at lines 7-10 unchanged.
3131
4. From the repo root, grep for stale version strings (`.dev0` suffixes, the old SECURITY.md parenthetical, or the previous shipped release):
3232
```sh
3333
PREVIOUS=0.2.0
3434
PREVIOUS_ESC=$(echo "$PREVIOUS" | sed 's/[.]/\\&/g')
35-
git grep -nE "\.dev0|\(currently \`|${PREVIOUS_ESC}"
35+
git grep -nE "\.dev0|\(currently |${PREVIOUS_ESC}"
3636
```
3737
Point `PREVIOUS` at the release you are replacing (no `v` prefix). Fix any hits that should name the new version (for example `docs/deprecation-policy.md`).
3838
5. Open a PR, get review, merge to `master`.
@@ -68,11 +68,10 @@ Do the changelog in one PR and the version bump in a second PR, or combine them
6868
found { print }
6969
' CHANGELOG.md >"$NOTES"
7070
grep -q '[^[:space:]]' "$NOTES" || { echo "error: no CHANGELOG.md section for $VERSION" >&2; exit 1; }
71+
printf '\n**Full changelog:** https://github.com/cppalliance/claude-code-chat-browser/blob/v%s/CHANGELOG.md\n' "$VERSION" >>"$NOTES"
7172
gh release create "v${VERSION}" --title "v${VERSION}" --verify-tag --notes-file "$NOTES"
7273
```
73-
Append a footer line after extraction, matching prior releases:
74-
`**Full changelog:** https://github.com/cppalliance/claude-code-chat-browser/blob/vX.Y.Z/CHANGELOG.md`
75-
On macOS, Linux, and Git Bash, `mktemp` works. Or paste the `[X.Y.Z]` section in the GitHub UI and add the same footer link.
74+
The `printf` adds the same "Full changelog" footer that `v0.1.0` and `v0.2.0` carry. On macOS, Linux, and Git Bash, `mktemp` works. Or paste the `[X.Y.Z]` section in the GitHub UI and add that footer line by hand.
7675

7776
## After release
7877

docs/deprecation-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ For fields **only read by the bundled SPA** (no external integrators on a tagged
4343

4444
## Versioning
4545

46-
Release versions follow `MAJOR.MINOR.PATCH` in `app.__version__` and [CHANGELOG](../CHANGELOG.md). Shipped tags include [`v0.1.0`](https://github.com/cppalliance/claude-code-chat-browser/releases/tag/v0.1.0) and [`v0.2.0`](https://github.com/cppalliance/claude-code-chat-browser/releases/tag/v0.2.0). Between releases, `main` may carry a `.dev0` suffix in `app.__version__` while developing the next version. The CHANGELOG `[Unreleased]` section is the source of truth for changes not yet tagged.
46+
Release versions follow `MAJOR.MINOR.PATCH` in `app.__version__` and [CHANGELOG](../CHANGELOG.md). Shipped tags include [`v0.1.0`](https://github.com/cppalliance/claude-code-chat-browser/releases/tag/v0.1.0) and [`v0.2.0`](https://github.com/cppalliance/claude-code-chat-browser/releases/tag/v0.2.0). Between releases, `master` may carry a `.dev0` suffix in `app.__version__` while developing the next version. The CHANGELOG `[Unreleased]` section is the source of truth for changes not yet tagged.
4747

4848
| Bump | Pre-1.0 meaning |
4949
|------|-----------------|

0 commit comments

Comments
 (0)