Skip to content

Commit 8f9ab78

Browse files
clean up content
1 parent cdcc21e commit 8f9ab78

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

RELEASING.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Releasing
22

3-
Manual release flow for **claude-code-chat-browser**. There is **no CI publish workflow**: a release is an annotated git tag plus a GitHub Release with notes. No wheel, npm package, or other artifact is attached.
3+
Manual release flow for claude-code-chat-browser. A release is an annotated git tag and a GitHub Release with notes. There is no CI publish workflow, and no wheel, npm package, or other artifact is attached.
44

5-
`v0.1.0` (2026-06-18) is the only shipped tag so far. `v0.2.0` is in progress and these steps describe how it is being cut.
5+
`v0.1.0` (2026-06-18) is the only shipped tag so far. `v0.2.0` is in progress; these steps describe how it is being cut.
66

77
## Version source
88

99
The only version string is `__version__` in `app.py` (line 3). There is no `pyproject.toml` version field.
1010

11-
Between tagged releases, `master` may carry a `.dev0` suffix (for example `0.2.0.dev0` while `0.2.0` was in development). The shipped tag always drops `.dev0`.
11+
Between tagged releases, `master` may carry a `.dev0` suffix (for example `0.2.0.dev0` while `0.2.0` was in development). The shipped tag drops `.dev0`.
1212

1313
## Pre-release checklist
1414

@@ -20,26 +20,26 @@ Between tagged releases, `master` may carry a `.dev0` suffix (for example `0.2.0
2020

2121
Do the changelog in one PR and the version bump in a second PR, or combine them on a `release/vX.Y.Z` branch. The `v0.2.0` cut used two PRs: changelog first (`docs/changelog-0-2-0`), then the bump (`release/v0.2.0`).
2222

23-
1. **Changelog** — edit [CHANGELOG.md](CHANGELOG.md) ([Keep a Changelog](https://keepachangelog.com/en/1.1.0/)):
23+
1. Edit [CHANGELOG.md](CHANGELOG.md) ([Keep a Changelog](https://keepachangelog.com/en/1.1.0/)):
2424
- Move everything under `## [Unreleased]` into a new `## [X.Y.Z] - YYYY-MM-DD` section with `### Added`, `### Changed`, `### Fixed`, or `### Removed` as needed.
2525
- Leave `## [Unreleased]` empty.
2626
- Update the footer compare links: `[Unreleased]``vX.Y.Z...HEAD`, add `[X.Y.Z]``vPREVIOUS...vX.Y.Z`.
27-
2. **Version bump** — on a branch from current `master`, set `app.py` line 3 to the release version without `.dev0` (for example `"0.2.0"`).
28-
3. **Stale references** — from the repo root, grep for the old `.dev0` suffix you are replacing:
27+
2. On a branch from current `master`, set `app.py` line 3 to the release version without `.dev0` (for example `"0.2.0"`).
28+
3. From the repo root, grep for the old `.dev0` suffix you are replacing:
2929
```sh
3030
git grep -n "\.dev0"
3131
```
3232
Update any documentation that still names the previous dev version (for example `docs/deprecation-policy.md`).
33-
4. **Open a PR**, get review, merge to `master`.
34-
5. **Tag** on the merge commit:
33+
4. Open a PR, get review, merge to `master`.
34+
5. Tag the merge commit:
3535
```sh
3636
git checkout master
3737
git pull
3838
git tag -a vX.Y.Z -m "vX.Y.Z"
3939
git push origin vX.Y.Z
4040
```
4141
Tag format: `vMAJOR.MINOR.PATCH` (for example `v0.2.0`).
42-
6. **GitHub Release** — publish a Release object, not just the tag. Pull the `## [X.Y.Z]` section from `CHANGELOG.md` and pass it to `gh`:
42+
6. Publish a GitHub Release, not just the tag. Pull the `## [X.Y.Z]` section from `CHANGELOG.md` and pass it to `gh`:
4343
```sh
4444
VERSION=X.Y.Z
4545
awk -v ver="$VERSION" '
@@ -49,13 +49,13 @@ Do the changelog in one PR and the version bump in a second PR, or combine them
4949
' CHANGELOG.md > /tmp/release-notes.md
5050
gh release create "v${VERSION}" --title "v${VERSION}" --notes-file /tmp/release-notes.md
5151
```
52-
On macOS/Linux and Git Bash, `/tmp/release-notes.md` is fine. Or create the release in the GitHub UI and paste the section there.
53-
7. **Optional**if the project later adds an explicit supported-version table in [SECURITY.md](SECURITY.md), update it when you cut a release. Today `SECURITY.md` only states that fixes land on latest `master`.
52+
On macOS, Linux, and Git Bash, `/tmp/release-notes.md` works. You can also create the release in the GitHub UI and paste the section there.
53+
7. Optional: if the project later adds a supported-version table in [SECURITY.md](SECURITY.md), update it when you cut a release. `SECURITY.md` today only says fixes land on latest `master`.
5454

5555
## After release
5656

57-
1. On `master`, bump `app.py` `__version__` to the next development suffix if you are starting the next cycle (for example `0.3.0.dev0` after shipping `0.2.0`). Record that commit in `CHANGELOG.md` under `[Unreleased]` only if there is user-visible work; a bare dev bump can ride with the next feature PR.
58-
2. New work accumulates under `## [Unreleased]` until the next release.
57+
1. On `master`, bump `app.py` `__version__` to the next development suffix if you are starting 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.
58+
2. New work goes under `## [Unreleased]` until the next release.
5959

6060
## References
6161

0 commit comments

Comments
 (0)