From e2d4357b79d7f8a14d6a2e21326c6caf83425450 Mon Sep 17 00:00:00 2001 From: Edouard Bozon Date: Thu, 22 Feb 2024 15:27:31 +0100 Subject: [PATCH] feat(semver): add nx migration generator --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 88acedd68..4146b48d0 100644 --- a/README.md +++ b/README.md @@ -437,6 +437,23 @@ release: 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. +## Nx Release migration + +If you want to migrate to Nx Release, run the following command: + +```bash +nx g @jscutlery/semver:migrate-nx-release +``` + +By executing this generator, the existing `@jscutlery/semver` configuration will be removed, and Nx Release will be appropriately configured for your projects. + +> [!NOTE] +> The migration process does not currently support the sync mode. +> Complex or highly customized configurations may require additional manual adjustments after running the migration generator. +> 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. + +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). + ## Compatibility overview with Nx | Version | Required Package |