Skip to content

Commit 8805493

Browse files
committed
Document release notes format in AGENTS/release.md
1 parent efd8731 commit 8805493

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

AGENTS/release.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,12 @@ Suggested guidance to give users:
2121
- Wait for the **tag** CI run (not the branch run). Both trigger, but only the
2222
tag run (`refs/tags/v*`) creates the GitHub Release. Use `gh run list` and
2323
look for the run with the tag ref (e.g., `v0.1.0`), then `gh run watch <id>`.
24-
- After CI completes, update release notes: `gh release edit v0.1.0 --notes-file -`
24+
- After CI completes, update release notes with a "What's New" section:
25+
```
26+
gh release edit v0.1.0 --notes "## What's New
27+
28+
- **Feature name** - Brief description of the change."
29+
```
2530

2631
## Required GitHub secrets (release signing)
2732

0 commit comments

Comments
 (0)