Skip to content

Commit

Permalink
fix(release): add overall nx release command (#20535)
Browse files Browse the repository at this point in the history
Co-authored-by: James Henry <james@henry.sc>
Co-authored-by: Isaac Mann <isaacplmann@gmail.com>
  • Loading branch information
3 people authored and jaysoo committed Dec 22, 2023
1 parent 56b1274 commit 1485323
Show file tree
Hide file tree
Showing 21 changed files with 758 additions and 34 deletions.
60 changes: 50 additions & 10 deletions docs/generated/cli/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ nx release

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.

## Options
## Shared Options

### dryRun
### dry-run

Type: `boolean`

Expand Down Expand Up @@ -57,6 +57,46 @@ Show version number

## Subcommands

### Base Command Options

Create a version and release for the workspace, generate a changelog, and optionally publish the packages

```shell
nx release [specifier]
```

#### Options

##### help

Type: `boolean`

Show help

##### skip-publish

Type: `boolean`

Skip publishing by automatically answering no to the confirmation prompt for publishing

##### specifier

Type: `string`

Exact version or semver keyword to apply to the selected release group.

##### version

Type: `boolean`

Show version number

##### yes

Type: `boolean`

Automatically answer yes to the confirmation prompt for publishing

### version

Create a version and release for one or more applications and libraries
Expand Down Expand Up @@ -169,6 +209,14 @@ Type: `string`

Custom git commit message to use when committing the changes made by this command. {version} will be dynamically interpolated when performing fixed releases, interpolated tags will be appended to the commit body when performing independent releases.

##### git-remote

Type: `string`

Default: `origin`

Alternate git remote in the form {user}/{repo} on which to create the Github release (useful for testing)

##### git-tag

Type: `boolean`
Expand All @@ -187,14 +235,6 @@ Type: `string`

Custom git tag message to use when tagging the changes made by this command. This defaults to be the same value as the tag itself.

##### gitRemote

Type: `string`

Default: `origin`

Alternate git remote in the form {user}/{repo} on which to create the Github release (useful for testing)

##### help

Type: `boolean`
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/cli/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Show information about "my-app" in a human readable format.:
nx show project my-app --json false
```

## Options
## Shared Options

### help

Expand Down
16 changes: 16 additions & 0 deletions docs/generated/manifests/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -638,6 +638,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Manage Releases",
"path": "/core-features/manage-releases",
"id": "manage-releases",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Plugin Features",
"path": "/core-features/plugin-features",
Expand Down Expand Up @@ -730,6 +738,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Manage Releases",
"path": "/core-features/manage-releases",
"id": "manage-releases",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Plugin Features",
"path": "/core-features/plugin-features",
Expand Down
22 changes: 22 additions & 0 deletions docs/generated/manifests/nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -870,6 +870,17 @@
"path": "/core-features/integrate-with-editors",
"tags": ["integrate-with-editors"]
},
{
"id": "manage-releases",
"name": "Manage Releases",
"description": "Learn how Nx provides tools to help you manage releasing your projects.",
"mediaImage": "",
"file": "shared/core-features/manage-releases",
"itemList": [],
"isExternal": false,
"path": "/core-features/manage-releases",
"tags": ["manage-releases"]
},
{
"id": "plugin-features",
"name": "Plugin Features",
Expand Down Expand Up @@ -997,6 +1008,17 @@
"path": "/core-features/integrate-with-editors",
"tags": ["integrate-with-editors"]
},
"/core-features/manage-releases": {
"id": "manage-releases",
"name": "Manage Releases",
"description": "Learn how Nx provides tools to help you manage releasing your projects.",
"mediaImage": "",
"file": "shared/core-features/manage-releases",
"itemList": [],
"isExternal": false,
"path": "/core-features/manage-releases",
"tags": ["manage-releases"]
},
"/core-features/plugin-features": {
"id": "plugin-features",
"name": "Plugin Features",
Expand Down
9 changes: 9 additions & 0 deletions docs/generated/manifests/tags.json
Original file line number Diff line number Diff line change
Expand Up @@ -396,6 +396,15 @@
"path": "/recipes/nx-console/console-troubleshooting"
}
],
"manage-releases": [
{
"description": "Learn how Nx provides tools to help you manage releasing your projects.",
"file": "shared/core-features/manage-releases",
"id": "manage-releases",
"name": "Manage Releases",
"path": "/core-features/manage-releases"
}
],
"use-task-executors": [
{
"description": "",
Expand Down
60 changes: 50 additions & 10 deletions docs/generated/packages/nx/documents/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ nx release

Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`.

## Options
## Shared Options

### dryRun
### dry-run

Type: `boolean`

Expand Down Expand Up @@ -57,6 +57,46 @@ Show version number

## Subcommands

### Base Command Options

Create a version and release for the workspace, generate a changelog, and optionally publish the packages

```shell
nx release [specifier]
```

#### Options

##### help

Type: `boolean`

Show help

##### skip-publish

Type: `boolean`

Skip publishing by automatically answering no to the confirmation prompt for publishing

##### specifier

Type: `string`

Exact version or semver keyword to apply to the selected release group.

##### version

Type: `boolean`

Show version number

##### yes

Type: `boolean`

Automatically answer yes to the confirmation prompt for publishing

### version

Create a version and release for one or more applications and libraries
Expand Down Expand Up @@ -169,6 +209,14 @@ Type: `string`

Custom git commit message to use when committing the changes made by this command. {version} will be dynamically interpolated when performing fixed releases, interpolated tags will be appended to the commit body when performing independent releases.

##### git-remote

Type: `string`

Default: `origin`

Alternate git remote in the form {user}/{repo} on which to create the Github release (useful for testing)

##### git-tag

Type: `boolean`
Expand All @@ -187,14 +235,6 @@ Type: `string`

Custom git tag message to use when tagging the changes made by this command. This defaults to be the same value as the tag itself.

##### gitRemote

Type: `string`

Default: `origin`

Alternate git remote in the form {user}/{repo} on which to create the Github release (useful for testing)

##### help

Type: `boolean`
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/packages/nx/documents/show.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Show information about "my-app" in a human readable format.:
nx show project my-app --json false
```

## Options
## Shared Options

### help

Expand Down
7 changes: 7 additions & 0 deletions docs/map.json
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,13 @@
"tags": ["integrate-with-editors"],
"file": "shared/core-features/integrate-with-editors"
},
{
"name": "Manage Releases",
"description": "Learn how Nx provides tools to help you manage releasing your projects.",
"id": "manage-releases",
"tags": ["manage-releases"],
"file": "shared/core-features/manage-releases"
},
{
"name": "Plugin Features",
"id": "plugin-features",
Expand Down
Loading

0 comments on commit 1485323

Please sign in to comment.