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

feat(core): alpha implementation of nx release #19110

Merged
merged 15 commits into from
Sep 18, 2023
Merged
Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions docs/generated/cli/affected.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,15 +115,15 @@ Type: `boolean`

Show help

### nx-bail
### nxBail

Type: `boolean`

Default: `false`

Stop command execution after the first failed task

### nx-ignore-cycles
### nxIgnoreCycles

Type: `boolean`

Expand Down Expand Up @@ -151,7 +151,7 @@ Type: `string`

This is the name of the tasks runner configured in nx.json

### skip-nx-cache
### skipNxCache

Type: `boolean`

Expand Down
6 changes: 3 additions & 3 deletions docs/generated/cli/exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ Type: `string`

Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser.

### nx-bail
### nxBail

Type: `boolean`

Default: `false`

Stop command execution after the first failed task

### nx-ignore-cycles
### nxIgnoreCycles

Type: `boolean`

Expand Down Expand Up @@ -77,7 +77,7 @@ Type: `string`

This is the name of the tasks runner configured in nx.json

### skip-nx-cache
### skipNxCache

Type: `boolean`

Expand Down
250 changes: 250 additions & 0 deletions docs/generated/cli/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,250 @@
---
title: 'release - CLI command'
description: '**ALPHA**: Orchestrate versioning and publishing of applications and libraries'
---

# release

**ALPHA**: Orchestrate versioning and publishing of applications and libraries

## Usage

```shell
nx release
```

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

## Options

### dryRun

Type: `boolean`

Default: `false`

Preview the changes without updating files/creating releases

### groups

Type: `string`

One or more release groups to target with the current command.

### help

Type: `boolean`

Show help

### projects

Type: `string`

Projects to run. (comma/space delimited project names and/or patterns)

### verbose

Type: `boolean`

Prints additional information about the commands (e.g., stack traces)

### version

Type: `boolean`

Show version number

## Subcommands

### version

Create a version and release for one or more applications and libraries

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

#### Options

##### help

Type: `boolean`

Show help

##### preid

Type: `string`

The optional prerelease identifier to apply to the version, in the case that specifier has been set to prerelease.

##### specifier

Type: `string`

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

##### version

Type: `boolean`

Show version number

### changelog

Generate a changelog for one or more projects, and optionally push to Github

```shell
nx release changelog [version]
```

#### Options

##### from

Type: `string`

The git reference to use as the start of the changelog. If not set it will attempt to resolve the latest tag and use that

##### 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`

Show help

##### interactive

Type: `boolean`

##### tagVersionPrefix

Type: `string`

Default: `v`

Prefix to apply to the version when creating the Github release tag

##### to

Type: `string`

Default: `HEAD`

The git reference to use as the end of the changelog

##### version

Type: `string`

The version to create a Github release and changelog for

### publish

Publish a versioned project to a registry

```shell
nx release publish
```

#### Options

##### all

Type: `boolean`

Default: `true`

[deprecated] `run-many` runs all targets on all projects in the workspace if no projects are provided. This option is no longer required.

##### exclude

Type: `string`

Exclude certain projects from being processed

##### graph

Type: `string`

Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser.

##### help

Type: `boolean`

Show help

##### nxBail

Type: `boolean`

Default: `false`

Stop command execution after the first failed task

##### nxIgnoreCycles

Type: `boolean`

Default: `false`

Ignore cycles in the task graph

##### parallel

Type: `string`

Max number of parallel processes [default is 3]

##### projects

Type: `string`

Projects to run. (comma/space delimited project names and/or patterns)

##### registry

Type: `string`

The registry to publish to

##### runner

Type: `string`

This is the name of the tasks runner configured in nx.json

##### skipNxCache

Type: `boolean`

Default: `false`

Rerun the tasks even when the results are available in the cache

##### tag

Type: `string`

The distribution tag to apply to the published package

##### verbose

Type: `boolean`

Prints additional information about the commands (e.g., stack traces)

##### version

Type: `boolean`

Show version number
6 changes: 3 additions & 3 deletions docs/generated/cli/run-many.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,15 @@ Type: `boolean`

Show help

### nx-bail
### nxBail

Type: `boolean`

Default: `false`

Stop command execution after the first failed task

### nx-ignore-cycles
### nxIgnoreCycles

Type: `boolean`

Expand Down Expand Up @@ -147,7 +147,7 @@ Type: `string`

This is the name of the tasks runner configured in nx.json

### skip-nx-cache
### skipNxCache

Type: `boolean`

Expand Down
9 changes: 9 additions & 0 deletions docs/generated/devkit/NxJsonConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Nx.json configuration
- [npmScope](../../devkit/documents/NxJsonConfiguration#npmscope): string
- [plugins](../../devkit/documents/NxJsonConfiguration#plugins): string[]
- [pluginsConfig](../../devkit/documents/NxJsonConfiguration#pluginsconfig): Record<string, unknown>
- [release](../../devkit/documents/NxJsonConfiguration#release): NxReleaseConfiguration
- [targetDefaults](../../devkit/documents/NxJsonConfiguration#targetdefaults): TargetDefaults
- [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions): Object
- [workspaceLayout](../../devkit/documents/NxJsonConfiguration#workspacelayout): Object
Expand Down Expand Up @@ -163,6 +164,14 @@ Configuration for Nx Plugins

---

### release

• `Optional` **release**: `NxReleaseConfiguration`

**ALPHA**: Configuration for `nx release` (versioning and publishing of applications and libraries)

---

### targetDefaults

• `Optional` **targetDefaults**: `TargetDefaults`
Expand Down
13 changes: 13 additions & 0 deletions docs/generated/devkit/Workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ use ProjectsConfigurations or NxJsonConfiguration
- [plugins](../../devkit/documents/Workspace#plugins): string[]
- [pluginsConfig](../../devkit/documents/Workspace#pluginsconfig): Record<string, unknown>
- [projects](../../devkit/documents/Workspace#projects): Record<string, ProjectConfiguration>
- [release](../../devkit/documents/Workspace#release): NxReleaseConfiguration
- [targetDefaults](../../devkit/documents/Workspace#targetdefaults): TargetDefaults
- [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions): Object
- [version](../../devkit/documents/Workspace#version): number
Expand Down Expand Up @@ -219,6 +220,18 @@ Projects' projects

---

### release

• `Optional` **release**: `NxReleaseConfiguration`

**ALPHA**: Configuration for `nx release` (versioning and publishing of applications and libraries)

#### Inherited from

[NxJsonConfiguration](../../devkit/documents/NxJsonConfiguration).[release](../../devkit/documents/NxJsonConfiguration#release)

---

### targetDefaults

• `Optional` **targetDefaults**: `TargetDefaults`
Expand Down
Loading