-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(core): alpha implementation of
nx release
- Loading branch information
1 parent
3771c32
commit bddac27
Showing
69 changed files
with
5,489 additions
and
868 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,170 @@ | ||
--- | ||
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) | ||
|
||
### 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 | ||
|
||
##### 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 | ||
|
||
##### help | ||
|
||
Type: `boolean` | ||
|
||
Show help | ||
|
||
##### registry | ||
|
||
Type: `string` | ||
|
||
The registry to publish to | ||
|
||
##### tag | ||
|
||
Type: `string` | ||
|
||
The distribution tag to apply to the published package | ||
|
||
##### version | ||
|
||
Type: `boolean` | ||
|
||
Show version number |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{ | ||
"name": "release-publish", | ||
"implementation": "/packages/js/src/executors/release-publish/release-publish.impl.ts", | ||
"schema": { | ||
"$schema": "http://json-schema.org/schema", | ||
"version": 2, | ||
"title": "Implementation details of `nx release publish`", | ||
"description": "DO NOT INVOKE DIRECTLY WITH `nx run`. Use `nx release publish` instead.", | ||
"type": "object", | ||
"properties": { | ||
"packageRoot": { | ||
"type": "string", | ||
"description": "The root directory of the directory (containing a manifest file at its root) to publish. Defaults to the project root." | ||
}, | ||
"registry": { | ||
"type": "string", | ||
"description": "The registry to publish the package to." | ||
}, | ||
"tag": { | ||
"type": "string", | ||
"description": "The distribution tag to apply to the published package." | ||
} | ||
}, | ||
"required": [], | ||
"presets": [] | ||
}, | ||
"description": "DO NOT INVOKE DIRECTLY WITH `nx run`. Use `nx release publish` instead.", | ||
"hidden": true, | ||
"aliases": [], | ||
"path": "/packages/js/src/executors/release-publish/schema.json", | ||
"type": "executor" | ||
} |
Oops, something went wrong.