diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index 8ca866cb595c9f..76a4cdd5fb16a1 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -263,6 +263,19 @@ branch. $ git checkout -b v1.2.3-proposal upstream/v1.x-staging ``` +
+Security release + +When performing Security Releases, the `vN.x.x-proposal` branch should be +branched off of `vN.x`. + +```console +$ git checkout -b v1.2.3-proposal upstream/v1.x +git cherry-pick ... # cherry-pick nodejs-private PR commits directly into the proposal +``` + +
+ ### 3. Update `src/node_version.h` Set the version for the proposed release using the following macros, which are @@ -458,6 +471,9 @@ Notable changes: PR-URL: TBD ``` +**Note**: Ensure to push the proposal branch to the nodejs-private repository. +Otherwise, you will leak the commits before the security release. + ### 6. Propose release on GitHub