Skip to content

doc: update security release prepare command #64699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RafaelGSS wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −3
Open

doc: update security release prepare command #64699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions doc/contributing/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,22 +377,28 @@ git checkout -b v1.2.3-proposal upstream/v1.x-staging
You can also run:

```bash
git node release -S --prepare --security=../vulnerabilities.json --filterLabel vX.x
git node release -S --prepare --security=../vulnerabilities.json
```

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

Example:

```bash
git checkout v20.x
git node release -S --prepare --security=../vulnerabilities.json --filterLabel v20.x
git node release -S --prepare --security=../vulnerabilities.json
```

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

```bash
git node release -S --prepare --security=../vulnerabilities.json --filterLabel v20.x --newVersion 20.20.0
git node release -S --prepare --security=../vulnerabilities.json --newVersion 20.20.0
```

<details>
Expand Down
Loading