miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(release): version prefix dependents (#28729)

Browse Source
This commit is contained in:
Thu Vo 2024-11-06 17:57:25 +07:00 committed by GitHub
parent 51f47f0329
commit bd40a56e19
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 164 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/generated/manifests/menus.json
View File

@ -2033,6 +2033,14 @@
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Configuring Version Prefix for Dependency Versions",
"path": "/recipes/nx-release/configuration-version-prefix",
"id": "configuration-version-prefix",
"isExternal": false,
"children": [],
"disableCollapsible": false
}
],
"disableCollapsible": false
@ -3751,6 +3759,14 @@
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Configuring Version Prefix for Dependency Versions",
"path": "/recipes/nx-release/configuration-version-prefix",
"id": "configuration-version-prefix",
"isExternal": false,
"children": [],
"disableCollapsible": false
}
],
"disableCollapsible": false
@ -3859,6 +3875,14 @@
"children": [],
"disableCollapsible": false
},
{
"name": "Configuring Version Prefix for Dependency Versions",
"path": "/recipes/nx-release/configuration-version-prefix",
"id": "configuration-version-prefix",
"isExternal": false,
"children": [],
"disableCollapsible": false
},
{
"name": "Enterprise",
"path": "/nx-enterprise",

33
docs/generated/manifests/nx.json
View File

@ -2779,6 +2779,17 @@
"isExternal": false,
"path": "/recipes/nx-release/build-before-versioning",
"tags": ["nx-release"]
},
{
"id": "configuration-version-prefix",
"name": "Configuring Version Prefix for Dependency Versions",
"description": "",
"mediaImage": "",
"file": "shared/recipes/nx-release/configuration-version-prefix",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-release/configuration-version-prefix",
"tags": ["nx-release"]
}
],
"isExternal": false,
@ -5135,6 +5146,17 @@
"isExternal": false,
"path": "/recipes/nx-release/build-before-versioning",
"tags": ["nx-release"]
},
{
"id": "configuration-version-prefix",
"name": "Configuring Version Prefix for Dependency Versions",
"description": "",
"mediaImage": "",
"file": "shared/recipes/nx-release/configuration-version-prefix",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-release/configuration-version-prefix",
"tags": ["nx-release"]
}
],
"isExternal": false,
@ -5284,6 +5306,17 @@
"path": "/recipes/nx-release/build-before-versioning",
"tags": ["nx-release"]
},
"/recipes/nx-release/configuration-version-prefix": {
"id": "configuration-version-prefix",
"name": "Configuring Version Prefix for Dependency Versions",
"description": "",
"mediaImage": "",
"file": "shared/recipes/nx-release/configuration-version-prefix",
"itemList": [],
"isExternal": false,
"path": "/recipes/nx-release/configuration-version-prefix",
"tags": ["nx-release"]
},
"/nx-enterprise": {
"id": "nx-enterprise",
"name": "Enterprise",

7
docs/generated/manifests/tags.json
View File

@ -567,6 +567,13 @@
"name": "Build Before Versioning",
"path": "/recipes/nx-release/build-before-versioning"
},
{
"description": "",
"file": "shared/recipes/nx-release/configuration-version-prefix",
"id": "configuration-version-prefix",
"name": "Configuring Version Prefix for Dependency Versions",
"path": "/recipes/nx-release/configuration-version-prefix"
},
{
"description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
"file": "generated/packages/nx/documents/release",

6
docs/map.json
View File

@ -1065,6 +1065,12 @@
"id": "build-before-versioning",
"tags": ["nx-release"],
"file": "shared/recipes/nx-release/build-before-versioning"
},
{
"name": "Configuring Version Prefix for Dependency Versions",
"id": "configuration-version-prefix",
"tags": ["nx-release"],
"file": "shared/recipes/nx-release/configuration-version-prefix"
}
]
}

93
docs/shared/recipes/nx-release/configuration-version-prefix.md Normal file
View File

@ -0,0 +1,93 @@
# Configuring Version Prefix for Dependency Versions
This guide explains how to configure a custom version prefix in Nx Release using the `versionPrefix` option. The version prefix allows you to automatically add a specific prefix format to dependencies, providing control over how dependency versions are specified in your project’s `package.json` files.
## The `versionPrefix` Option
The `versionPrefix` option controls which prefix is applied to dependency versions during the versioning process. By default, `versionPrefix` is set to `"auto"`, which selects a prefix format (either `""`, `"~"`, `"^"`, or `"="`) by respecting what is already in the `package.json` file.
For example, having the following `package.json` file:
```json
{
"name": "my-package",
"version": "0.1.1",
"dependencies": {
"dependency-one": "~1.2.3",
"dependency-two": "^2.3.4",
"dependency-three": "3.0.0"
}
}
```
Then next patch bump will be:
```json
{
"name": "my-package",
"version": "0.1.2",
"dependencies": {
"dependency-one": "~1.2.4",
"dependency-two": "^2.3.4",
"dependency-three": "3.0.0"
}
}
```
Preserving the prefix for `dependency-one` and `dependency-two` and continuing to use no prefix for `dependency-three`.
### Available Prefix Options
You can set `versionPrefix` to one of the following values:
- `"auto"`: Automatically chooses a prefix based on the existing declaration in the `package.json` file. This is the default value.
- `""`: Uses the exact version without a prefix.
- `"~"`: Specifies compatibility with patch-level updates.
- `"^"`: Specifies compatibility with minor-level updates.
- `"="`: Locks the version to an exact match (the `=` is not commonly used in the JavaScript ecosystem, but is in others such as Cargo for Rust).
Example configuration:
```json
{
"release": {
"version": {
"generatorOptions": {
"versionPrefix": "~"
}
}
}
}
```
## Configuring Version Prefix in `nx.json` or `project.json`
To set the versionPrefix option globally or for a specific project, add it to either your `nx.json` or `project.json` configuration files:
```jsonc
{
"release": {
"version": {
"generatorOptions": {
"versionPrefix": "^" // or "", "~", "^", "=" depending on your preference
}
}
}
}
```
With the `versionPrefix` option set to `^`, your `package.json` dependencies might look like this:
```json
{
"name": "my-package",
"version": "0.1.1",
"dependencies": {
"dependency-one": "^1.0.0",
"dependency-two": "^2.3.4",
"dependency-three": "^3.0.0"
}
}
```
This configuration helps enforce a consistent approach to dependency management, allowing flexibility in how updates to dependencies are tracked and managed across your project.

1
docs/shared/reference/sitemap.md
View File

@ -169,6 +169,7 @@
- [Configure Changelog Format](/recipes/nx-release/configure-changelog-format)
- [Publish a Custom Dist Directory](/recipes/nx-release/publish-custom-dist-directory)
- [Build Before Versioning](/recipes/nx-release/build-before-versioning)
- [Configuring Version Prefix for Dependency Versions](/recipes/nx-release/configuration-version-prefix)
- [Troubleshoot Nx Console Issues](/recipes/nx-console/console-troubleshooting)
- [Enterprise](/nx-enterprise)
- [Activate Powerpack](/nx-enterprise/activate-powerpack)