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

Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
nrwl · Sep 18, 2023 · 9116c29 · 9116c29
1 parent 11fcb8f
commit 9116c29
Show file tree

Hide file tree

Showing 74 changed files with 6,015 additions and 917 deletions.
diff --git a/docs/generated/cli/affected.md b/docs/generated/cli/affected.md
@@ -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`
 
@@ -151,7 +151,7 @@ Type: `string`
 
 This is the name of the tasks runner configured in nx.json
 
-### skip-nx-cache
+### skipNxCache
 
 Type: `boolean`
 

diff --git a/docs/generated/cli/exec.md b/docs/generated/cli/exec.md
@@ -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`
 
@@ -77,7 +77,7 @@ Type: `string`
 
 This is the name of the tasks runner configured in nx.json
 
-### skip-nx-cache
+### skipNxCache
 
 Type: `boolean`
 

diff --git a/docs/generated/cli/release.md b/docs/generated/cli/release.md
@@ -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
diff --git a/docs/generated/cli/run-many.md b/docs/generated/cli/run-many.md
@@ -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`
 
@@ -147,7 +147,7 @@ Type: `string`
 
 This is the name of the tasks runner configured in nx.json
 
-### skip-nx-cache
+### skipNxCache
 
 Type: `boolean`
 

diff --git a/docs/generated/devkit/NxJsonConfiguration.md b/docs/generated/devkit/NxJsonConfiguration.md
@@ -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&lt;string, unknown&gt;
+- [release](../../devkit/documents/NxJsonConfiguration#release): NxReleaseConfiguration
 - [targetDefaults](../../devkit/documents/NxJsonConfiguration#targetdefaults): TargetDefaults
 - [tasksRunnerOptions](../../devkit/documents/NxJsonConfiguration#tasksrunneroptions): Object
 - [workspaceLayout](../../devkit/documents/NxJsonConfiguration#workspacelayout): Object
@@ -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`

diff --git a/docs/generated/devkit/Workspace.md b/docs/generated/devkit/Workspace.md
@@ -28,6 +28,7 @@ use ProjectsConfigurations or NxJsonConfiguration
 - [plugins](../../devkit/documents/Workspace#plugins): string[]
 - [pluginsConfig](../../devkit/documents/Workspace#pluginsconfig): Record&lt;string, unknown&gt;
 - [projects](../../devkit/documents/Workspace#projects): Record&lt;string, ProjectConfiguration&gt;
+- [release](../../devkit/documents/Workspace#release): NxReleaseConfiguration
 - [targetDefaults](../../devkit/documents/Workspace#targetdefaults): TargetDefaults
 - [tasksRunnerOptions](../../devkit/documents/Workspace#tasksrunneroptions): Object
 - [version](../../devkit/documents/Workspace#version): number
@@ -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`