fix(semver): 🐞 deprecate --syncVersions

jscutlery · Feb 17, 2022 · 65e5910 · 65e5910
1 parent 6c22e4c
commit 65e5910
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -75,23 +75,23 @@ nx run workspace:version [....options]
 
 #### Available options
 
-| name                         | type            | default     | description                                      |
-| ---------------------------- | --------------- | ----------- | ------------------------------------------------ |
-| **`--dryRun`**               | `boolean`       | `false`     | run with dry mode                                |
-| **`--noVerify`**             | `boolean`       | `false`     | skip git hooks                                   |
-| **`--push`**                 | `boolean`       | `false`     | push the release against git origin              |
-| **`--syncVersions`**         | `boolean`       | `false`     | lock/sync versions between projects              |
-| **`--skipRootChangelog`**    | `boolean`       | `false`     | skip generating root changelog                   |
-| **`--skipProjectChangelog`** | `boolean`       | `false`     | skip generating project changelog                |
-| **`--origin`**               | `string`        | `'origin'`  | push against git remote repository               |
-| **`--baseBranch`**           | `string`        | `'main'`    | push against git base branch                     |
-| **`--changelogHeader`**      | `string`        | `undefined` | custom Markdown header for changelogs            |
-| **`--releaseAs`**            | `string`        | `undefined` | specify the level of change                      |
-| **`--preid`**                | `string`        | `undefined` | prerelease identifier                            |
-| **`--tagPrefix`**            | `string | null` | `undefined` | specify the tag prefix                           |
-| **`--postTargets`**          | `string[]`      | `[]`        | specify a list of target to execute post-release |
-| **`--trackDeps`**            | `boolean`       | `false`     | use dependencies when calculating a version bump |
-| **`--commitMessageFormat`**  | `string`        | `undefined` | format the auto-generated message commit         |
+| name                         | type       | default     | description                                      |
+| ---------------------------- | ---------- | ----------- | ------------------------------------------------ |
+| **`--dryRun`**               | `boolean`  | `false`     | run with dry mode                                |
+| **`--noVerify`**             | `boolean`  | `false`     | skip git hooks                                   |
+| **`--push`**                 | `boolean`  | `false`     | push the release against git origin              |
+| **`--syncVersions`**         | `boolean`  | `false`     | lock/sync versions between projects              |
+| **`--skipRootChangelog`**    | `boolean`  | `false`     | skip generating root changelog                   |
+| **`--skipProjectChangelog`** | `boolean`  | `false`     | skip generating project changelog                |
+| **`--origin`**               | `string`   | `'origin'`  | push against git remote repository               |
+| **`--baseBranch`**           | `string`   | `'main'`    | push against git base branch                     |
+| **`--changelogHeader`**      | `string`   | `undefined` | custom Markdown header for changelogs            |
+| **`--releaseAs`**            | `string`   | `undefined` | specify the level of change                      |
+| **`--preid`**                | `string`   | `undefined` | prerelease identifier                            |
+| **`--tagPrefix`**            | `string`   | `undefined` | specify the tag prefix                           |
+| **`--postTargets`**          | `string[]` | `[]`        | specify a list of target to execute post-release |
+| **`--trackDeps`**            | `boolean`  | `false`     | use dependencies when calculating a version bump |
+| **`--commitMessageFormat`**  | `string`   | `undefined` | format the auto-generated message commit         |
 
 #### Configuration using the file
 

diff --git a/packages/semver/src/executors/version/schema.d.ts b/packages/semver/src/executors/version/schema.d.ts
@@ -1,4 +1,11 @@
-export type ReleaseIdentifier = 'patch' | 'minor' | 'major' | 'premajor' | 'preminor' | 'prepatch' | 'prerelease';
+export type ReleaseIdentifier =
+  | 'patch'
+  | 'minor'
+  | 'major'
+  | 'premajor'
+  | 'preminor'
+  | 'prepatch'
+  | 'prerelease';
 
 export interface VersionBuilderSchema {
   dryRun?: boolean;
@@ -10,6 +17,10 @@ export interface VersionBuilderSchema {
   push?: boolean;
   remote?: string;
   baseBranch?: string;
+  /**
+   * @deprecated
+   * @sunset 3.0.0
+   */
   syncVersions?: boolean;
   skipRootChangelog?: boolean;
   skipProjectChangelog?: boolean;

diff --git a/packages/semver/src/executors/version/schema.json b/packages/semver/src/executors/version/schema.json
@@ -36,7 +36,7 @@
       "default": "main"
     },
     "syncVersions": {
-      "description": "Sync all package versions.",
+      "description": "(Deprecated) Sync all package versions.",
       "type": "boolean",
       "default": false
     },

diff --git a/packages/semver/src/generators/install/schema.json b/packages/semver/src/generators/install/schema.json
@@ -6,10 +6,9 @@
   "cli": "nx",
   "properties": {
     "syncVersions": {
-      "description": "Lock/sync versions between packages",
+      "description": "(Deprecated) Lock/sync versions between packages",
       "type": "boolean",
-      "default": false,
-      "x-prompt": "Lock/sync versions between packages?"
+      "default": false
     },
     "projects": {
       "description": "Which projects should be versioned independently",