Skip to content

Commit 970ef88

Browse files
committed
docs: align GitHub Release title/notes style with v1.0.x
Title is the version only; body mirrors CHANGELOG sections.
1 parent 53ba442 commit 970ef88

1 file changed

Lines changed: 15 additions & 20 deletions

File tree

‎docs/releases.md‎

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -40,33 +40,28 @@ This document explains how Branchy uses `CHANGELOG.md` and GitHub Releases.
4040

4141
## GitHub Release Notes
4242

43-
Use this shape for release notes:
43+
Use this shape for release notes (same sections as `CHANGELOG.md`):
4444

4545
```text
46-
Branchy v0.1.0-alpha.1
46+
### Changed
4747
48-
Summary:
49-
- Short release purpose.
48+
- Short concrete bullets from the version section of CHANGELOG.md.
5049
51-
Highlights:
52-
- Important shipped behavior.
50+
### Fixed
5351
54-
Operations:
55-
- Migration notes.
56-
- Required env or deployment notes.
52+
- ...
5753
58-
Verification:
59-
- go test ./...
60-
- go vet ./...
61-
- docker build
62-
- smoke test status
54+
### Operations
6355
64-
Known limitations:
65-
- What is intentionally not done yet.
56+
- Migration notes, env, or deploy notes when relevant.
6657
```
6758

59+
GitHub Release **title** is the version only (`v1.1.0-alpha.1`), not
60+
`Branchy v…`. Copy the matching `CHANGELOG.md` version section into the release
61+
body (skip the `## vX.Y.Z` heading).
62+
6863
For `alpha`, `beta`, and `rc` versions, mark the GitHub Release as pre-release.
69-
For the public MVP tag `v0.1.0`, publish a normal GitHub Release.
64+
For stable tags, publish a normal GitHub Release.
7065

7166
## Commands
7267

@@ -78,18 +73,18 @@ git push origin main
7873
git push origin v0.1.0-alpha.1
7974
gh release create v0.1.0-alpha.1 \
8075
--prerelease \
81-
--title "Branchy v0.1.0-alpha.1" \
76+
--title "v0.1.0-alpha.1" \
8277
--notes-file /tmp/branchy-release-notes.md
8378
```
8479

85-
Create the public MVP release:
80+
Create a stable release:
8681

8782
```sh
8883
git tag -a v0.1.0 -m "v0.1.0"
8984
git push origin main
9085
git push origin v0.1.0
9186
gh release create v0.1.0 \
92-
--title "Branchy v0.1.0" \
87+
--title "v0.1.0" \
9388
--notes-file /tmp/branchy-release-notes.md
9489
```
9590

0 commit comments

Comments
 (0)