Skip to content
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.

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

docs: document git-node-release #399

Merged
merged 1 commit into from
Apr 4, 2020
Merged
Changes from all commits
Commits
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
33 changes: 32 additions & 1 deletion docs/git-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ A custom Git command for managing pull requests. You can run it as
- [Optional Settings](#git-node-land-optional-settings)
- [`git node backport`](#git-node-backport)
- [Example](#example)
- [`git node release`](#git-node-release)
- [Example](#example-1)
- [`git node sync`](#git-node-sync)
- [`git node metadata`](#git-node-metadata)
- [Optional Settings](#git-node-metadata-optional-settings)
Expand All @@ -20,7 +22,7 @@ A custom Git command for managing pull requests. You can run it as
- [`git node v8 backport <sha..>`](#git-node-v8-backport-sha)
- [General options](#general-options)
- [`git node wpt`](#git-node-wpt)
- [Example](#example-1)
- [Example](#example-2)

## `git node land`

Expand Down Expand Up @@ -185,6 +187,35 @@ $ git node sync
$ git node backport 12344 --to 10
```

## `git node release`

```sh
git-node release [newVersion|options]

Manage an in-progress release or start a new one.

Positionals:
newVersion, options Version number of the release to be prepared or promoted

Options:
--version Show version number [boolean]
--help Show help [boolean]
--prepare Prepare a new release of Node.js [boolean]
--security Demarcate the new security release as a security release [boolean]
```

### Example

```sh
# Prepare a new release of Node.js tagged 1.2.3
git node release --prepare 1.2.3
```

```sh
# Prepare a new release of Node.js with an automatically-determined version number.
git node release --prepare
```

## `git node sync`

Demo: https://asciinema.org/a/221230
Expand Down