Skip to content

Commit cdadbb3

Browse files
committed
doc: update security release prepare command
Signed-off-by: RafaelGSS <rafael.nunu@hotmail.com>
1 parent aedf2a4 commit cdadbb3

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

doc/contributing/releases.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -377,22 +377,28 @@ git checkout -b v1.2.3-proposal upstream/v1.x-staging
377377
You can also run:
378378

379379
```bash
380-
git node release -S --prepare --security=../vulnerabilities.json --filterLabel vX.x
380+
git node release -S --prepare --security=../vulnerabilities.json
381381
```
382382

383+
The `--security` flag takes the path to the `vulnerabilities.json` file (or to
384+
the root of the `security-release` repository). The reports and dependency
385+
updates to cherry-pick are selected automatically from each entry's
386+
`affectedVersions` mapping for the release line you are on, and the matching
387+
`CVE-ID` trailers are added from the same file.
388+
383389
Example:
384390

385391
```bash
386392
git checkout v20.x
387-
git node release -S --prepare --security=../vulnerabilities.json --filterLabel v20.x
393+
git node release -S --prepare --security=../vulnerabilities.json
388394
```
389395

390396
to automate the remaining steps until step 6 or you can perform it manually
391397
following the below steps. For semver-minors, you can pass the new version
392398
explicitly with `--newVersion` arg:
393399

394400
```bash
395-
git node release -S --prepare --security=../vulnerabilities.json --filterLabel v20.x --newVersion 20.20.0
401+
git node release -S --prepare --security=../vulnerabilities.json --newVersion 20.20.0
396402
```
397403

398404
<details>

0 commit comments

Comments
 (0)