Skip to content

Commit 7b85d91

Browse files
authored
feat(release): revamped nx release version implementation (#30418)
1 parent dbd8648 commit 7b85d91

File tree

75 files changed

+12648
-1805
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+12648
-1805
lines changed

docs/generated/cli/release.md

+2
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ nx release version [specifier]
6666
| `--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. |
6767
| `--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. |
6868
| `--git-push` | boolean | Whether or not to automatically push the changes made by this command to the remote git repository. |
69+
| `--git-push-args` | string | Additional arguments to pass to the `git push` command invoked behind the scenes. |
6970
| `--git-remote` | string | Alternate git remote to push commits and tags to (can be useful for testing). (Default: `origin`) |
7071
| `--git-tag` | boolean | Whether or not to automatically tag the changes made by this command. |
7172
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |
@@ -94,6 +95,7 @@ nx release changelog [version]
9495
| `--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. |
9596
| `--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. |
9697
| `--git-push` | boolean | Whether or not to automatically push the changes made by this command to the remote git repository. |
98+
| `--git-push-args` | string | Additional arguments to pass to the `git push` command invoked behind the scenes. |
9799
| `--git-remote` | string | Alternate git remote to push commits and tags to (can be useful for testing). (Default: `origin`) |
98100
| `--git-tag` | boolean | Whether or not to automatically tag the changes made by this command. |
99101
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |

docs/generated/devkit/ProjectConfiguration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -98,9 +98,9 @@ Project specific configuration for `nx release`
9898

9999
#### Type declaration
100100

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

105105
---
106106

docs/generated/packages/js/generators/release-version.json

+23-4
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,40 @@
1111
"properties": {
1212
"projects": {
1313
"type": "array",
14+
"hidden": true,
15+
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
1416
"description": "The ProjectGraphProjectNodes being versioned in the current execution.",
1517
"items": { "type": "object" }
1618
},
1719
"projectGraph": {
1820
"type": "object",
21+
"hidden": true,
22+
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
1923
"description": "ProjectGraph instance"
2024
},
21-
"specifier": {
22-
"type": "string",
23-
"description": "Exact version or semver keyword to apply to the selected release group. Overrides specifierSource."
24-
},
2525
"releaseGroup": {
2626
"type": "object",
27+
"hidden": true,
28+
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
2729
"description": "The resolved release group configuration, including name, relevant to all projects in the current execution."
2830
},
31+
"conventionalCommitsConfig": {
32+
"type": "object",
33+
"hidden": true,
34+
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
35+
"description": "The conventional commits configuration to use when determining the next version of the project.",
36+
"default": {}
37+
},
38+
"firstRelease": {
39+
"type": "boolean",
40+
"hidden": true,
41+
"$comment": "This is not configured/passed by the user. It is provided by the version command.",
42+
"description": "Whether this is the first release of the project (which skips some validation within the generator)."
43+
},
44+
"specifier": {
45+
"type": "string",
46+
"description": "Exact version or semver keyword to apply to the selected release group. Overrides specifierSource."
47+
},
2948
"specifierSource": {
3049
"type": "string",
3150
"default": "prompt",

docs/generated/packages/nx/documents/release.md

+2
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ nx release version [specifier]
6666
| `--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. |
6767
| `--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. |
6868
| `--git-push` | boolean | Whether or not to automatically push the changes made by this command to the remote git repository. |
69+
| `--git-push-args` | string | Additional arguments to pass to the `git push` command invoked behind the scenes. |
6970
| `--git-remote` | string | Alternate git remote to push commits and tags to (can be useful for testing). (Default: `origin`) |
7071
| `--git-tag` | boolean | Whether or not to automatically tag the changes made by this command. |
7172
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |
@@ -94,6 +95,7 @@ nx release changelog [version]
9495
| `--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. |
9596
| `--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. |
9697
| `--git-push` | boolean | Whether or not to automatically push the changes made by this command to the remote git repository. |
98+
| `--git-push-args` | string | Additional arguments to pass to the `git push` command invoked behind the scenes. |
9799
| `--git-remote` | string | Alternate git remote to push commits and tags to (can be useful for testing). (Default: `origin`) |
98100
| `--git-tag` | boolean | Whether or not to automatically tag the changes made by this command. |
99101
| `--git-tag-args` | string | Additional arguments to pass to the `git tag` command invoked behind the scenes. |

0 commit comments

Comments
 (0)