Skip to content

Commit 4e9f2a2

Browse files
committed
📖 RELEASE.md: Document drafting release notes
Replace the TODO with the steps used for v2.4.4: start from GitHub's generated notes, lead with the Scorecard version and its release notes, list the action's own changes without Dependabot bumps, and share the draft before publishing. Assisted-by: LLM Signed-off-by: Stephen Augustus <[email protected]>
1 parent f618e8b commit 4e9f2a2

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

‎RELEASE.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,27 @@ Create a pull request with this change and merge into `main`.
7575

7676
## Drafting release notes
7777

78-
<!-- TODO(release): Provide details -->
78+
Start from GitHub's generated notes for the range, either by clicking
79+
**Generate release notes** on a
80+
[new draft release](https://github.com/ossf/scorecard-action/releases/new) or
81+
with:
82+
83+
```console
84+
gh api -X POST repos/ossf/scorecard-action/releases/generate-notes \
85+
-f tag_name=v100.0.0 -f previous_tag_name=<previous tag>
86+
```
87+
88+
Then edit, following
89+
[v2.4.4](https://github.com/ossf/scorecard-action/releases/tag/v2.4.4):
90+
91+
- Open with a sentence naming the Scorecard version the release moves to,
92+
linking that version's Scorecard release notes, which cover the changes to
93+
checks and results.
94+
- List the action's own changes. Drop Dependabot bumps unless they change
95+
behavior.
96+
- Keep **New Contributors** and the **Full Changelog** link as generated.
97+
98+
Save the draft and share it with the other maintainers.
7999

80100
## Release
81101

0 commit comments

Comments
 (0)