diff --git a/skills/hookdeck-cli-release/SKILL.md b/skills/hookdeck-cli-release/SKILL.md index 19e5c0b..0fa560e 100644 --- a/skills/hookdeck-cli-release/SKILL.md +++ b/skills/hookdeck-cli-release/SKILL.md @@ -136,11 +136,13 @@ The user may suggest a tag (e.g. `v2.0.1`). **Always sanity-check it** against w Use **[references/release-notes-template.md](references/release-notes-template.md)** as a starting skeleton. +**Sections:** Include only headings that have real content — **omit** empty sections (e.g. do not add “Breaking changes” with “None”). + **Patterns observed in this repo:** -- **Large GA (e.g. v2.0.0):** `Summary` → `Breaking changes / migration` → `New features` (subsections per area) → `Improvements / behavior changes` → optional `Internal`. +- **Large GA (e.g. v2.0.0):** `Summary`, then as needed: `Breaking changes / migration`, `New features` (subsections per area), `Improvements / behavior changes`, `Internal` — skip any block with nothing to say. - **Feature release (e.g. v1.9.0):** `## Features` with detailed bullets + **Full Changelog** compare link. -- **Patch (e.g. v1.9.1):** `## Fixes`, `## Updates`, PR links with authors + **Full Changelog**. +- **Patch (e.g. v1.9.1):** `## Fixes`, `## Updates`, PR links with authors + **Full Changelog** — omit unused sections. Always include a **Full Changelog** line: diff --git a/skills/hookdeck-cli-release/references/release-notes-template.md b/skills/hookdeck-cli-release/references/release-notes-template.md index 7c15ff7..ab40143 100644 --- a/skills/hookdeck-cli-release/references/release-notes-template.md +++ b/skills/hookdeck-cli-release/references/release-notes-template.md @@ -2,29 +2,31 @@ Copy and fill in for the GitHub release description (e.g. write into the temp file used with `gh release create --notes-file`). Adjust heading levels (`##` vs `###`) to match recent GA style (v2.0.0 used `###` subsections) or smaller patch style (v1.9.x used `##`). +**Do not include a section if there is nothing to say** — omit the heading entirely (do not add “Breaking changes” with “None”, empty “Fixes”, etc.). Typical releases only need a subset of the sections below. + ## Summary ## Breaking changes / migration - + ## New features - + ## Fixes - + ## Improvements / behavior changes - + ## Internal / reliability / infrastructure - + ## Contributors (optional)