docs: release notes format and patch notes for v2.0.0-beta to v2.4.0-beta
This commit is contained in:
1 parent
142325730d
commit
e0fa433ff9
6 files changed
+193
No files matched your search
@@ -0,0 +1,28 @@
|
||||
# Release notes format
|
||||
|
||||
Name: `vX.Y.Z-beta - Short theme` (theme is 2 to 6 words, sentence case).
|
||||
Tag: `vX.Y.Z-beta`, always with the `v`.
|
||||
|
||||
Body, in this order. Omit a section only when it would be empty, except Upgrading, which is always present.
|
||||
|
||||
1. Intro: one or two plain sentences on what the release is about. No heading.
|
||||
2. `## New`: user-visible features. Group with a bold title line (`**Group name**`) followed by bullets.
|
||||
3. `## Improvements and fixes`: flat bullets.
|
||||
4. `## API`: one bullet per endpoint change, `METHOD /v1/path` in backticks, then behaviour and status codes. Prefix breaking or shape changes with "Changed:".
|
||||
5. `## Under the hood`: dependencies, tests, docs, architecture. Only when relevant to contributors.
|
||||
6. `## Upgrading`: binary replacement, schema/migration changes, new env vars, behaviour changes for existing installs.
|
||||
7. `## Known limitations`: only when there are real ones.
|
||||
|
||||
Rules: bullets are full sentences ending with a period; user-facing wording, no commit prefixes; sentence-case headings; no horizontal rules, no metadata block, no "Pre-1.0" boilerplate (the prerelease flag says it); every release ships all 6 binaries from `task release`.
|
||||
|
||||
## Published releases
|
||||
|
||||
Each body lives in `docs/releases/<tag>.md`. Publish with `tea releases create --tag <tag> --title "<name>" --note-file docs/releases/<tag>.md --prerelease --asset <binary>` (one `--asset` per binary), after `task release`.
|
||||
|
||||
| Tag | Name |
|
||||
| --- | --- |
|
||||
| `2.0.0-beta` (legacy tag without the `v`, kept as is) | v2.0.0-beta - Vue 3 SPA and domain-driven backend |
|
||||
| `v2.1.0-beta` | v2.1.0-beta - Image upload in the editor |
|
||||
| `v2.2.0-beta` | v2.2.0-beta - Image crop, image removal & reset screens |
|
||||
| `v2.3.0-beta` | v2.3.0-beta - Multi-user invitations, display names & profile page |
|
||||
| `v2.4.0-beta` | v2.4.0-beta - Owner role, invite management & Settings page |
|
||||
Reference in new issue
Block a user