Skip to content

Commit e2d4357

Browse files
committed
feat(semver): add nx migration generator
1 parent 4d56a3b commit e2d4357

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,23 @@ release:
437437

438438
Note that you might need to configure a [deploy key](https://docs.gitlab.com/ee/user/project/deploy_keys/) in order to push to your remote repository.
439439

440+
## Nx Release migration
441+
442+
If you want to migrate to Nx Release, run the following command:
443+
444+
```bash
445+
nx g @jscutlery/semver:migrate-nx-release
446+
```
447+
448+
By executing this generator, the existing `@jscutlery/semver` configuration will be removed, and Nx Release will be appropriately configured for your projects.
449+
450+
> [!NOTE]
451+
> The migration process does not currently support the sync mode.
452+
> Complex or highly customized configurations may require additional manual adjustments after running the migration generator.
453+
> After running this generator, you will need to adjust any custom scripts or CI workflows related to versioning and releases to align with the new Nx release workflow.
454+
455+
For more details on using Nx Release, refer to the [official Nx documentation](https://nx.dev/recipes/nx-release/get-started-with-nx-release#get-started-with-nx-release).
456+
440457
## Compatibility overview with Nx
441458

442459
| Version | Required Package |

0 commit comments

Comments
 (0)