-
Notifications
You must be signed in to change notification settings - Fork 1
docs: add RELEASING.md for manual tag-and-notes releases #146
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+96
−2
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
ba1f8b8
docs: add RELEASING.md for the manual tag-and-notes release flow
clean6378-max-it 4263c9e
Address feedback
clean6378-max-it 10b3894
clean up content
clean6378-max-it d317966
docs: harden RELEASING.md with SECURITY sync and guarded release script
clean6378-max-it d6bc37f
docs: polish RELEASING.md for review feedback and sync SECURITY to 0.2.0
clean6378-max-it 7c24073
docs: correct SECURITY sync scope, grep pattern, and release notes fo…
clean6378-max-it 7490e1f
docs: harden RELEASING version checks and changelog extraction
clean6378-max-it File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| # Releasing | ||
|
|
||
| Manual release flow for claude-code-chat-browser. A release is a git tag plus a GitHub Release with notes. No CI publish workflow, and no wheel, npm package, or other artifact. | ||
|
|
||
| `v0.1.0` (2026-06-18) and `v0.2.0` (2026-07-30) are the shipped tags so far. The steps below apply to the next cut. | ||
|
|
||
| ## Version source | ||
|
|
||
| The release version is `__version__` in `app.py` line 3. There is no `pyproject.toml` version field. | ||
|
|
||
| `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. | ||
|
|
||
| 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`. | ||
|
|
||
| ## Pre-release checklist | ||
|
|
||
| 1. Confirm `master` is green in GitHub Actions (`.github/workflows/ci.yml`). | ||
| 2. Decide the semver bump using [docs/deprecation-policy.md](docs/deprecation-policy.md#versioning) (pre-1.0: patch for safe fixes, minor for additive work and deprecations). | ||
| 3. If the release removes or renames a documented API field, confirm the [two-release deprecation window](docs/deprecation-policy.md#removal-criteria) is satisfied. | ||
|
|
||
| ## Release checklist | ||
|
|
||
| Do the changelog in one PR and the version bump in a second PR, or combine them on a `release/vX.Y.Z` branch. For `v0.2.0` we used two PRs: changelog first (`docs/changelog-0-2-0`), then the bump (`release/v0.2.0`). | ||
|
|
||
| 1. Edit [CHANGELOG.md](CHANGELOG.md) ([Keep a Changelog](https://keepachangelog.com/en/1.1.0/)): | ||
| - Move everything under `## [Unreleased]` into a new `## [X.Y.Z] - YYYY-MM-DD` section with `### Added`, `### Changed`, `### Deprecated`, `### Fixed`, `### Removed`, or `### Security` as needed. | ||
| - Leave `## [Unreleased]` empty. | ||
| - Update the footer compare links: `[Unreleased]` → `vX.Y.Z...HEAD`, add `[X.Y.Z]` → `vPREVIOUS...vX.Y.Z`. | ||
| 2. On a branch from current `master`, set `app.py` line 3 to the release version without `.dev0` (for example `"0.2.0"`). | ||
| 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. | ||
| 4. From the repo root, grep for stale version strings (`.dev0` suffixes, the old SECURITY.md parenthetical, or the previous shipped release): | ||
| ```sh | ||
| PREVIOUS=0.2.0 | ||
| PREVIOUS_ESC=$(echo "$PREVIOUS" | sed 's/[.]/\\&/g') | ||
| git grep -nE "\.dev0|\(currently |${PREVIOUS_ESC}" | ||
| ``` | ||
| 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`). | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
| 5. Open a PR, get review, merge to `master`. | ||
| 6. Tag the merge commit (lightweight tag, same as `v0.1.0` and `v0.2.0`): | ||
| ```sh | ||
| git checkout master | ||
| git pull | ||
| git tag vX.Y.Z | ||
| git push origin vX.Y.Z | ||
| ``` | ||
| Tag format: `vMAJOR.MINOR.PATCH` (for example `v0.2.0`). | ||
| 7. Publish the GitHub Release after pushing the tag. From the repo root, extract the body from `CHANGELOG.md`: | ||
| ```sh | ||
| cd "$(git rev-parse --show-toplevel)" | ||
| VERSION=0.2.0 # no leading v; not the literal X.Y.Z placeholder | ||
| VERSION="${VERSION#v}" | ||
| case "$VERSION" in | ||
| *[!0-9.]*|'') echo "error: VERSION must look like 0.2.0" >&2; exit 1 ;; | ||
| *..*|.*|*.) echo "error: VERSION must look like 0.2.0" >&2; exit 1 ;; | ||
| *.*.*.*) echo "error: VERSION must look like 0.2.0" >&2; exit 1 ;; | ||
| *.*.*) ;; | ||
| *) echo "error: VERSION must look like 0.2.0" >&2; exit 1 ;; | ||
| esac | ||
| case "$VERSION" in | ||
| 0[0-9]*.*.*|*.[0][0-9]*.*|*.*.[0][0-9]*) | ||
| echo "error: VERSION components must not have leading zeros" >&2; exit 1 ;; | ||
| esac | ||
| NOTES="$(mktemp)" | ||
| trap 'rm -f "$NOTES"' EXIT | ||
| awk -v ver="$VERSION" ' | ||
| BEGIN { heading = "## [" ver "]" } | ||
| /^## \[/ { | ||
| if (found) exit | ||
| if (index($0, heading) == 1) { found=1 } | ||
| } | ||
| /^\[[^]]+\]:/ { if (found) exit } | ||
| found { print } | ||
| ' CHANGELOG.md >"$NOTES" | ||
| grep -v '^## \[' "$NOTES" | grep -q '[^[:space:]]' || { echo "error: no CHANGELOG.md section for $VERSION" >&2; exit 1; } | ||
| printf '\n\n**Full changelog:** https://github.com/cppalliance/claude-code-chat-browser/blob/v%s/CHANGELOG.md\n' "$VERSION" >>"$NOTES" | ||
| gh release create "v${VERSION}" --title "v${VERSION}" --verify-tag --notes-file "$NOTES" | ||
| ``` | ||
| 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. | ||
|
|
||
| ## After release | ||
|
|
||
| 1. On `master`, bump `app.py` `__version__` to the next development suffix when you start the next cycle (for example `0.3.0.dev0` after shipping `0.2.0`). Put that commit in `CHANGELOG.md` under `[Unreleased]` only when there is user-visible work; a bare dev bump can ride with the next feature PR. | ||
| 2. New work goes under `## [Unreleased]` until the next release. | ||
|
|
||
| ## References | ||
|
|
||
| | Topic | Location | | ||
| |-------|----------| | ||
| | Changelog format | [CHANGELOG.md](CHANGELOG.md) | | ||
| | Version bump | `app.py` line 3 | | ||
| | Supported versions blurb | `SECURITY.md` line 5 | | ||
| | Deprecation / semver | [docs/deprecation-policy.md](docs/deprecation-policy.md) | | ||
| | Security reporting | [SECURITY.md](SECURITY.md) | | ||
| | CI gates | [`.github/workflows/ci.yml`](.github/workflows/ci.yml), [CONTRIBUTING.md](CONTRIBUTING.md) | | ||
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
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.