diff options
author | Richard Lau <riclau@uk.ibm.com> | 2019-05-10 21:59:52 +0300 |
---|---|---|
committer | Michaƫl Zasso <targos@protonmail.com> | 2019-05-14 18:33:08 +0300 |
commit | b5498ed19b74cbf7eaff33d2f1942e6d0a19fe97 (patch) | |
tree | aec0ca6df18b1fb4c084af82da901cea21045a10 /doc/releases.md | |
parent | 4dbebfd4641f8d2c624a4c011520410c4521be88 (diff) |
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.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/releases.md b/doc/releases.md index 483b1f030c4..560336861fe 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 |