BuzzbeeSCD/openchamber
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(changelog): title every release and require one

Browse Source 
Every release file now carries a title: two to six plain words naming the
change a user would remember it for. The generator refuses a release without
one, promote carries the title from unreleased.md, and the unreleased
template opens with a title line. The changelog-authoring skill and the
format README describe how to write it.

Claude-Session: https://claude.ai/code/session_01VqV56Hez25hTxXH4ipJfzH
This commit is contained in:
Bohdan Triapitsyn
2026-09-05 16:45:29 +03:00
parent 475dc5ecb1
commit a1bc1368ae
144 changed files with 325 additions and 154 deletions
Download Patch File Download Diff File Expand all files Collapse all files
changelog/README.md
+3 -3
View File
@@ -6,7 +6,7 @@ One file per release, plus `unreleased.md` for what has not shipped. `bun run ch
---
version: 1.22.2
date: 2026-09-06
title: optional one-line headline
title: One-line headline, two to six words
---
Optional intro paragraph shown above the groups.
@@ -31,8 +31,8 @@ Optional intro paragraph shown above the groups.
- Only what the extension actually mounts. Written separately, on purpose.
```
Groups may appear in any order in a source file; the generator emits them as New, Improvements, Fixes, Misc and drops empty ones. A release without a `## VS Code` section is absent from the extension changelog. `unreleased.md` has no front matter.
Groups may appear in any order in a source file; the generator emits them as New, Improvements, Fixes, Misc and drops empty ones. A release without a `## VS Code` section is absent from the extension changelog. Every release needs a `title`; `unreleased.md` carries only the `title` line in its front matter and gets `version` and `date` at release time.
`bun run changelog:check` fails when the generated files are behind their sources; CI runs it. `oc-dev create-release` promotes `unreleased.md` to `<version>.md` with today's date and rebuilds.
How to write a bullet lives in `.agents/skills/changelog-authoring/SKILL.md`.
How to write the title and the bullets lives in `.agents/skills/changelog-authoring/SKILL.md`.