summaryrefslogtreecommitdiff
path: root/doc/releases.md
diff options
context:
space:
mode:
authorRichard Lau <riclau@uk.ibm.com>2019-05-10 14:59:52 -0400
committerRich Trott <rtrott@gmail.com>2019-05-13 16:20:10 -0700
commitb3be0bf21aab2837d64b33e44a54a80230e50465 (patch)
treecf3c551d1faefa62d4fe12cdf2305c2dcd10c053 /doc/releases.md
parent97815bd6e9dee6a893d94bc9085958f9af23ac85 (diff)
downloadandroid-node-v8-b3be0bf21aab2837d64b33e44a54a80230e50465.tar.gz
android-node-v8-b3be0bf21aab2837d64b33e44a54a80230e50465.tar.bz2
android-node-v8-b3be0bf21aab2837d64b33e44a54a80230e50465.zip
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: https://github.com/nodejs/Release/issues/437 Refs: https://github.com/nodejs/node/pull/27612#issuecomment-490698922 Refs: https://github.com/nodejs/nodejs-dist-indexer/pull/9 PR-URL: https://github.com/nodejs/node/pull/27643 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/releases.md')
-rw-r--r--doc/releases.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/releases.md b/doc/releases.md
index 483b1f030c..560336861f 100644
--- a/doc/releases.md
+++ b/doc/releases.md
@@ -345,6 +345,21 @@ Notable changes:
* Copy the notable changes list here, reformatted for plain-text
```
+For security releases, begin the commit message with the phrase
+`This is a security release.` to allow the
+[distribution indexer](https://github.com/nodejs/nodejs-dist-indexer) to
+identify it as such:
+
+```txt
+YYYY-MM-DD, Version x.y.z (Release Type)
+
+This is a security release.
+
+Notable changes:
+
+* Copy the notable changes list here, reformatted for plain-text
+```
+
### 6. Propose Release on GitHub
Push the release branch to `nodejs/node`, not to your own fork. This allows