From b5498ed19b74cbf7eaff33d2f1942e6d0a19fe97 Mon Sep 17 00:00:00 2001 From: Richard Lau Date: Fri, 10 May 2019 14:59:52 -0400 Subject: [PATCH] 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 Reviewed-By: Beth Griggs Reviewed-By: Franziska Hinkelmann Reviewed-By: Anto Aravinth Reviewed-By: Colin Ihrig Reviewed-By: James M Snell Reviewed-By: Ruben Bridgewater Reviewed-By: Rich Trott --- doc/releases.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/releases.md b/doc/releases.md index 483b1f030c4071..560336861fe2b1 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