From bf72e4ccc632156edc7c516bb471423ae438a9f7 Mon Sep 17 00:00:00 2001 From: Ruy Adorno Date: Thu, 20 Oct 2022 17:27:12 -0400 Subject: [PATCH] docs: add startLTS usage examples 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 --- components/git/release.js | 4 +++- docs/git-node.md | 5 +++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/components/git/release.js b/components/git/release.js index 29d2ba30..e20db483 100644 --- a/components/git/release.js +++ b/components/git/release.js @@ -36,7 +36,9 @@ export function builder(yargs) { describe: 'Version number of the release to be prepared or promoted' }) .example('git node release --prepare 1.2.3', - 'Prepare a new release of Node.js tagged v1.2.3'); + 'Prepare a release of Node.js tagged v1.2.3') + .example('git node --prepare --startLTS', + 'Prepare the first LTS release'); } export function handler(argv) { diff --git a/docs/git-node.md b/docs/git-node.md index 6b22205f..79c6000e 100644 --- a/docs/git-node.md +++ b/docs/git-node.md @@ -233,6 +233,11 @@ git node release --prepare 1.2.3 git node release --prepare ``` +```sh +# Prepare the first LTS release for a given release line +git node release --prepare --startLTS +``` + ## `git node sync` Demo: https://asciinema.org/a/221230