Skip to content

Commit 843d491

Browse files
committed
doc,meta: codify security release commit message
The release commit message for security releases have conventionally started with the phrase `This is a security release.`. Codify this as part of the release process so that the distribution indexer can use this to detect and mark releases as security releases. Fixes: nodejs/Release#437 Refs: nodejs#27612 (comment) Refs: nodejs/nodejs-dist-indexer#9
1 parent ac56dc9 commit 843d491

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/releases.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,21 @@ Notable changes:
345345
* Copy the notable changes list here, reformatted for plain-text
346346
```
347347

348+
For security releases, begin the commit message with the phrase
349+
`This is a security release.` to allow the
350+
[distribution indexer](https://github.com/nodejs/nodejs-dist-indexer) to
351+
identify it as such:
352+
353+
```txt
354+
YYYY-MM-DD, Version x.y.z (Release Type)
355+
356+
This is a security release.
357+
358+
Notable changes:
359+
360+
* Copy the notable changes list here, reformatted for plain-text
361+
```
362+
348363
### 6. Propose Release on GitHub
349364

350365
Push the release branch to `nodejs/node`, not to your own fork. This allows

0 commit comments

Comments
 (0)