Skip to content
Merged
2 changes: 2 additions & 0 deletions docs/generated/cli/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ nx release version [specifier]
| `--git-commit-args` | string | Additional arguments (added after the --message argument, which may or may not be customized with --git-commit-message) to pass to the `git commit` command invoked behind the scenes. |
| `--git-commit-message` | 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-push` | boolean | Whether or not to automatically push the changes made by this command to the remote git repository. |
| `--git-push-args` | string | Additional arguments to pass to the `git push` command invoked behind the scenes. |
| `--git-remote` | string | Alternate git remote to push commits and tags to (can be useful for testing). (Default: `origin`) |
| `--git-tag` | boolean | Whether or not to automatically tag the changes made by this command. |
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |
Expand Down Expand Up @@ -94,6 +95,7 @@ nx release changelog [version]
| `--git-commit-args` | string | Additional arguments (added after the --message argument, which may or may not be customized with --git-commit-message) to pass to the `git commit` command invoked behind the scenes. |
| `--git-commit-message` | 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-push` | boolean | Whether or not to automatically push the changes made by this command to the remote git repository. |
| `--git-push-args` | string | Additional arguments to pass to the `git push` command invoked behind the scenes. |
| `--git-remote` | string | Alternate git remote to push commits and tags to (can be useful for testing). (Default: `origin`) |
| `--git-tag` | boolean | Whether or not to automatically tag the changes made by this command. |
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |
Expand Down
6 changes: 3 additions & 3 deletions docs/generated/devkit/ProjectConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,9 @@ Project specific configuration for `nx release`

#### Type declaration

| Name | Type |
| :--------- | :------------------------------------------------------------------------------- |
| `version?` | `Pick`\<`NxReleaseVersionConfiguration`, `"generator"` \| `"generatorOptions"`\> |
| Name | Type |
| :--------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `version?` | `Pick`\<`NxReleaseVersionConfiguration`, `"generator"` \| `"generatorOptions"`\> \| `Pick`\<`NxReleaseVersionV2Configuration`, `"versionActions"` \| `"versionActionsOptions"` \| `"manifestRootsToUpdate"` \| `"currentVersionResolver"` \| `"currentVersionResolverMetadata"` \| `"fallbackCurrentVersionResolver"` \| `"versionPrefix"` \| `"preserveLocalDependencyProtocols"`\> |

---

Expand Down
27 changes: 23 additions & 4 deletions docs/generated/packages/js/generators/release-version.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,40 @@
"properties": {
"projects": {
"type": "array",
"hidden": true,
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
"description": "The ProjectGraphProjectNodes being versioned in the current execution.",
"items": { "type": "object" }
},
"projectGraph": {
"type": "object",
"hidden": true,
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
"description": "ProjectGraph instance"
},
"specifier": {
"type": "string",
"description": "Exact version or semver keyword to apply to the selected release group. Overrides specifierSource."
},
"releaseGroup": {
"type": "object",
"hidden": true,
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
"description": "The resolved release group configuration, including name, relevant to all projects in the current execution."
},
"conventionalCommitsConfig": {
"type": "object",
"hidden": true,
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
"description": "The conventional commits configuration to use when determining the next version of the project.",
"default": {}
},
"firstRelease": {
"type": "boolean",
"hidden": true,
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
"description": "Whether this is the first release of the project (which skips some validation within the generator)."
},
"specifier": {
"type": "string",
"description": "Exact version or semver keyword to apply to the selected release group. Overrides specifierSource."
},
"specifierSource": {
"type": "string",
"default": "prompt",
Expand Down
2 changes: 2 additions & 0 deletions docs/generated/packages/nx/documents/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ nx release version [specifier]
| `--git-commit-args` | string | Additional arguments (added after the --message argument, which may or may not be customized with --git-commit-message) to pass to the `git commit` command invoked behind the scenes. |
| `--git-commit-message` | 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-push` | boolean | Whether or not to automatically push the changes made by this command to the remote git repository. |
| `--git-push-args` | string | Additional arguments to pass to the `git push` command invoked behind the scenes. |
| `--git-remote` | string | Alternate git remote to push commits and tags to (can be useful for testing). (Default: `origin`) |
| `--git-tag` | boolean | Whether or not to automatically tag the changes made by this command. |
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |
Expand Down Expand Up @@ -94,6 +95,7 @@ nx release changelog [version]
| `--git-commit-args` | string | Additional arguments (added after the --message argument, which may or may not be customized with --git-commit-message) to pass to the `git commit` command invoked behind the scenes. |
| `--git-commit-message` | 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-push` | boolean | Whether or not to automatically push the changes made by this command to the remote git repository. |
| `--git-push-args` | string | Additional arguments to pass to the `git push` command invoked behind the scenes. |
| `--git-remote` | string | Alternate git remote to push commits and tags to (can be useful for testing). (Default: `origin`) |
| `--git-tag` | boolean | Whether or not to automatically tag the changes made by this command. |
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |
Expand Down
Loading