Skip to content

Commit 9d9fb2f

Browse files
authored
docs: document git-node-release (#399)
1 parent 4928645 commit 9d9fb2f

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

docs/git-node.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ A custom Git command for managing pull requests. You can run it as
1010
- [Optional Settings](#git-node-land-optional-settings)
1111
- [`git node backport`](#git-node-backport)
1212
- [Example](#example)
13+
- [`git node release`](#git-node-release)
14+
- [Example](#example-1)
1315
- [`git node sync`](#git-node-sync)
1416
- [`git node metadata`](#git-node-metadata)
1517
- [Optional Settings](#git-node-metadata-optional-settings)
@@ -20,7 +22,7 @@ A custom Git command for managing pull requests. You can run it as
2022
- [`git node v8 backport <sha..>`](#git-node-v8-backport-sha)
2123
- [General options](#general-options)
2224
- [`git node wpt`](#git-node-wpt)
23-
- [Example](#example-1)
25+
- [Example](#example-2)
2426

2527
## `git node land`
2628

@@ -185,6 +187,35 @@ $ git node sync
185187
$ git node backport 12344 --to 10
186188
```
187189

190+
## `git node release`
191+
192+
```sh
193+
git-node release [newVersion|options]
194+
195+
Manage an in-progress release or start a new one.
196+
197+
Positionals:
198+
newVersion, options Version number of the release to be prepared or promoted
199+
200+
Options:
201+
--version Show version number [boolean]
202+
--help Show help [boolean]
203+
--prepare Prepare a new release of Node.js [boolean]
204+
--security Demarcate the new security release as a security release [boolean]
205+
```
206+
207+
### Example
208+
209+
```sh
210+
# Prepare a new release of Node.js tagged 1.2.3
211+
git node release --prepare 1.2.3
212+
```
213+
214+
```sh
215+
# Prepare a new release of Node.js with an automatically-determined version number.
216+
git node release --prepare
217+
```
218+
188219
## `git node sync`
189220

190221
Demo: https://asciinema.org/a/221230

0 commit comments

Comments
 (0)