Skip to content

Commit 474305c

Browse files
committedOct 27, 2022
docs: add startLTS usage examples (#654)
I reach to `node-core-utils` for automating the LTS release commit but I couldn't get it to work due to the lack of a proper usage example. I'm adding examples to both the markdown docs and the cli help output which are the places I would have loved to have found these. Signed-off-by: Ruy Adorno <[email protected]>
1 parent ed011d5 commit 474305c

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed
 

‎components/git/release.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,9 @@ export function builder(yargs) {
3636
describe: 'Version number of the release to be prepared or promoted'
3737
})
3838
.example('git node release --prepare 1.2.3',
39-
'Prepare a new release of Node.js tagged v1.2.3');
39+
'Prepare a release of Node.js tagged v1.2.3')
40+
.example('git node --prepare --startLTS',
41+
'Prepare the first LTS release');
4042
}
4143

4244
export function handler(argv) {

‎docs/git-node.md

+5
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,11 @@ git node release --prepare 1.2.3
233233
git node release --prepare
234234
```
235235

236+
```sh
237+
# Prepare the first LTS release for a given release line
238+
git node release --prepare --startLTS
239+
```
240+
236241
## `git node sync`
237242

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

0 commit comments

Comments
 (0)
Please sign in to comment.