docs(release): update release docs

nrwl · Dec 17, 2024 · a0ffa95 · a0ffa95
1 parent 5ae0229
commit a0ffa95
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/generated/cli/release.md b/docs/generated/cli/release.md
@@ -43,6 +43,7 @@ nx release [specifier]
 | ----------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `--first-release` | boolean | Indicates that this is the first release for the selected release group. If the current version cannot be determined as usual, the version on disk will be used as a fallback. This is useful when using git or the registry to determine the current version of packages, since those sources are only available after the first release. Also indicates that changelog generation should not assume a previous git tag exists and that publishing should not check for the existence of the package before running. |
 | `--help`          | boolean | Show help.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `--preid`         | string  | The optional prerelease identifier to apply to the version. This will only be applied in the case that the specifier argument has been set to `prerelease` OR when conventional commits are enabled, in which case it will modify the resolved specifier from conventional commits to be its prerelease equivalent. E.g. minor -> preminor. (Default: ``)                                                                                                                                                             |
 | `--skip-publish`  | boolean | Skip publishing by automatically answering no to the confirmation prompt for publishing.                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | `--specifier`     | string  | Exact version or semver keyword to apply to the selected release group.                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | `--version`       | boolean | Show version number.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |

diff --git a/docs/generated/packages/nx/documents/release.md b/docs/generated/packages/nx/documents/release.md
@@ -43,6 +43,7 @@ nx release [specifier]
 | ----------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `--first-release` | boolean | Indicates that this is the first release for the selected release group. If the current version cannot be determined as usual, the version on disk will be used as a fallback. This is useful when using git or the registry to determine the current version of packages, since those sources are only available after the first release. Also indicates that changelog generation should not assume a previous git tag exists and that publishing should not check for the existence of the package before running. |
 | `--help`          | boolean | Show help.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `--preid`         | string  | The optional prerelease identifier to apply to the version. This will only be applied in the case that the specifier argument has been set to `prerelease` OR when conventional commits are enabled, in which case it will modify the resolved specifier from conventional commits to be its prerelease equivalent. E.g. minor -> preminor. (Default: ``)                                                                                                                                                             |
 | `--skip-publish`  | boolean | Skip publishing by automatically answering no to the confirmation prompt for publishing.                                                                                                                                                                                                                                                                                                                                                                                                                              |
 | `--specifier`     | string  | Exact version or semver keyword to apply to the selected release group.                                                                                                                                                                                                                                                                                                                                                                                                                                               |
 | `--version`       | boolean | Show version number.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |