@salesforce/plugin-release-management 6.1.20 → 6.1.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +24 -40
  2. package/oclif.manifest.json +342 -342
  3. package/package.json +4 -4
package/README.md CHANGED
@@ -29,7 +29,7 @@ Once the package has been built and signed it will be published to npm. The comm
29
29
  ## Install
30
30
 
31
31
  ```bash
32
- sfdx plugins:install release-management@x.y.z
32
+ sf plugins install @salesforce/plugin-release-management@x.y.z
33
33
  ```
34
34
 
35
35
  ## Issues
@@ -38,22 +38,7 @@ Please report any issues at https://github.com/forcedotcom/cli/issues
38
38
 
39
39
  ## Contributing
40
40
 
41
- 1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
42
- 2. Create a new issue before starting your project so that we can keep track of
43
- what you are trying to add/fix. That way, we can also offer suggestions or
44
- let you know if there is already an effort in progress.
45
- 3. Fork this repository.
46
- 4. [Build the plugin locally](#build)
47
- 5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
48
- 6. Edit the code in your fork.
49
- 7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
50
- 8. Sign CLA (see [CLA](#cla) below).
51
- 9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
52
-
53
- ### CLA
54
-
55
- External contributors will be required to sign a Contributor's License
56
- Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
41
+ If you're interested in contributing, take a look at the [CONTRIBUTING](CONTRIBUTING.md) guide.
57
42
 
58
43
  ### Build
59
44
 
@@ -64,24 +49,23 @@ To build the plugin locally, make sure to have yarn installed and run the follow
64
49
  git clone git@github.com:salesforcecli/plugin-release-management
65
50
 
66
51
  # Install the dependencies and compile
67
- yarn install
68
- yarn build
52
+ yarn && yarn build
69
53
  ```
70
54
 
71
- To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
55
+ To use your plugin, run using the local `./bin/dev.js` or `./bin/dev.cmd` file.
72
56
 
73
57
  ```bash
74
58
  # Run using local run file.
75
- ./bin/dev npm
59
+ ./bin/dev.js npm
76
60
  ```
77
61
 
78
62
  There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
79
63
 
80
64
  ```bash
81
- # Link your plugin to the sfdx cli
82
- sfdx plugins:link .
65
+ # Link your plugin to the sf cli
66
+ sf plugins link .
83
67
  # To verify
84
- sfdx plugins
68
+ sf plugins
85
69
  ```
86
70
 
87
71
  # Commands
@@ -149,7 +133,7 @@ EXAMPLES
149
133
  $ sfdx channel promote --candidate latest-rc --target latest --platform win --platform mac
150
134
  ```
151
135
 
152
- _See code: [src/commands/channel/promote.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/channel/promote.ts)_
136
+ _See code: [src/commands/channel/promote.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/channel/promote.ts)_
153
137
 
154
138
  ## `sfdx cli artifacts compare`
155
139
 
@@ -173,7 +157,7 @@ EXAMPLES
173
157
  $ sfdx cli artifacts compare
174
158
  ```
175
159
 
176
- _See code: [src/commands/cli/artifacts/compare.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/artifacts/compare.ts)_
160
+ _See code: [src/commands/cli/artifacts/compare.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/artifacts/compare.ts)_
177
161
 
178
162
  ## `sfdx cli install jit test`
179
163
 
@@ -194,7 +178,7 @@ EXAMPLES
194
178
  $ sfdx cli install jit test
195
179
  ```
196
180
 
197
- _See code: [src/commands/cli/install/jit/test.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/install/jit/test.ts)_
181
+ _See code: [src/commands/cli/install/jit/test.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/install/jit/test.ts)_
198
182
 
199
183
  ## `sfdx cli install test`
200
184
 
@@ -235,7 +219,7 @@ EXAMPLES
235
219
  $ sfdx cli install test --cli sf --method tarball --channel stable-rc
236
220
  ```
237
221
 
238
- _See code: [src/commands/cli/install/test.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/install/test.ts)_
222
+ _See code: [src/commands/cli/install/test.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/install/test.ts)_
239
223
 
240
224
  ## `sfdx cli release automerge`
241
225
 
@@ -266,7 +250,7 @@ EXAMPLES
266
250
  $ sfdx cli release automerge --owner salesforcecli --repo sfdx-cli --pul-number 1049
267
251
  ```
268
252
 
269
- _See code: [src/commands/cli/release/automerge.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/release/automerge.ts)_
253
+ _See code: [src/commands/cli/release/automerge.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/release/automerge.ts)_
270
254
 
271
255
  ## `sfdx cli release build`
272
256
 
@@ -329,7 +313,7 @@ EXAMPLES
329
313
  $ sfdx cli release build --only @salesforce/plugin-source,@salesforce/plugin-info@1.2.3
330
314
  ```
331
315
 
332
- _See code: [src/commands/cli/release/build.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/release/build.ts)_
316
+ _See code: [src/commands/cli/release/build.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/release/build.ts)_
333
317
 
334
318
  ## `sfdx cli releasenotes`
335
319
 
@@ -370,7 +354,7 @@ EXAMPLES
370
354
  $ sfdx cli releasenotes --cli sf --markdown > changes.md
371
355
  ```
372
356
 
373
- _See code: [src/commands/cli/releasenotes.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/releasenotes.ts)_
357
+ _See code: [src/commands/cli/releasenotes.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/releasenotes.ts)_
374
358
 
375
359
  ## `sfdx cli tarballs prepare`
376
360
 
@@ -398,7 +382,7 @@ EXAMPLES
398
382
  $ sfdx cli tarballs prepare
399
383
  ```
400
384
 
401
- _See code: [src/commands/cli/tarballs/prepare.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/tarballs/prepare.ts)_
385
+ _See code: [src/commands/cli/tarballs/prepare.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/tarballs/prepare.ts)_
402
386
 
403
387
  ## `sfdx cli tarballs smoke`
404
388
 
@@ -428,7 +412,7 @@ EXAMPLES
428
412
  $ sfdx cli tarballs smoke
429
413
  ```
430
414
 
431
- _See code: [src/commands/cli/tarballs/smoke.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/tarballs/smoke.ts)_
415
+ _See code: [src/commands/cli/tarballs/smoke.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/tarballs/smoke.ts)_
432
416
 
433
417
  ## `sfdx cli tarballs verify`
434
418
 
@@ -460,7 +444,7 @@ EXAMPLES
460
444
  $ sfdx cli tarballs verify --cli sf
461
445
  ```
462
446
 
463
- _See code: [src/commands/cli/tarballs/verify.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/tarballs/verify.ts)_
447
+ _See code: [src/commands/cli/tarballs/verify.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/tarballs/verify.ts)_
464
448
 
465
449
  ## `sfdx cli versions inspect`
466
450
 
@@ -512,7 +496,7 @@ EXAMPLES
512
496
  $ sfdx cli versions inspect -l npm -c latest -d chalk -s
513
497
  ```
514
498
 
515
- _See code: [src/commands/cli/versions/inspect.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/cli/versions/inspect.ts)_
499
+ _See code: [src/commands/cli/versions/inspect.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/cli/versions/inspect.ts)_
516
500
 
517
501
  ## `sfdx dependabot automerge`
518
502
 
@@ -552,7 +536,7 @@ EXAMPLES
552
536
  $ sfdx dependabot automerge --max-version-bump major
553
537
  ```
554
538
 
555
- _See code: [src/commands/dependabot/automerge.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/dependabot/automerge.ts)_
539
+ _See code: [src/commands/dependabot/automerge.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/dependabot/automerge.ts)_
556
540
 
557
541
  ## `sfdx github check closed`
558
542
 
@@ -579,7 +563,7 @@ EXAMPLES
579
563
  $ sfdx github check closed -o me@gus.com
580
564
  ```
581
565
 
582
- _See code: [src/commands/github/check/closed.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/github/check/closed.ts)_
566
+ _See code: [src/commands/github/check/closed.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/github/check/closed.ts)_
583
567
 
584
568
  ## `sfdx npm dependencies pin`
585
569
 
@@ -605,7 +589,7 @@ DESCRIPTION
605
589
  in the package.json
606
590
  ```
607
591
 
608
- _See code: [src/commands/npm/dependencies/pin.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/npm/dependencies/pin.ts)_
592
+ _See code: [src/commands/npm/dependencies/pin.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/npm/dependencies/pin.ts)_
609
593
 
610
594
  ## `sfdx npm package release`
611
595
 
@@ -639,7 +623,7 @@ DESCRIPTION
639
623
  publish npm package
640
624
  ```
641
625
 
642
- _See code: [src/commands/npm/package/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/npm/package/release.ts)_
626
+ _See code: [src/commands/npm/package/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/npm/package/release.ts)_
643
627
 
644
628
  ## `sfdx plugins trust allowlist add`
645
629
 
@@ -809,6 +793,6 @@ EXAMPLES
809
793
  $ sfdx repositories --json | jq -r '.result[] | select(.name=="sfdx-core") | .packages[] | .url
810
794
  ```
811
795
 
812
- _See code: [src/commands/repositories/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.20/src/commands/repositories/index.ts)_
796
+ _See code: [src/commands/repositories/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/6.1.22/src/commands/repositories/index.ts)_
813
797
 
814
798
  <!-- commandsstop -->
@@ -161,80 +161,6 @@
161
161
  "promote.js"
162
162
  ]
163
163
  },
164
- "cli:releasenotes": {
165
- "aliases": [],
166
- "args": {},
167
- "description": "pull all relevant information for writing release notes.\nRequires the GH_TOKEN to be set in the environment.",
168
- "examples": [
169
- "<%= config.bin %> <%= command.id %> --cli sf",
170
- "<%= config.bin %> <%= command.id %> --cli sfdx",
171
- "<%= config.bin %> <%= command.id %> --cli sf --since 1.0.0",
172
- "<%= config.bin %> <%= command.id %> --cli sfdx --since 7.19.0",
173
- "<%= config.bin %> <%= command.id %> --cli sf > changes.txt",
174
- "<%= config.bin %> <%= command.id %> --cli sf --markdown > changes.md"
175
- ],
176
- "flags": {
177
- "json": {
178
- "description": "Format output as json.",
179
- "helpGroup": "GLOBAL",
180
- "name": "json",
181
- "allowNo": false,
182
- "type": "boolean"
183
- },
184
- "flags-dir": {
185
- "helpGroup": "GLOBAL",
186
- "name": "flags-dir",
187
- "summary": "Import flag values from a directory.",
188
- "hasDynamicHelp": false,
189
- "multiple": false,
190
- "type": "option"
191
- },
192
- "cli": {
193
- "char": "c",
194
- "name": "cli",
195
- "required": true,
196
- "summary": "the cli to pull information for",
197
- "hasDynamicHelp": false,
198
- "multiple": false,
199
- "options": [
200
- "sf",
201
- "sfdx"
202
- ],
203
- "type": "option"
204
- },
205
- "since": {
206
- "char": "s",
207
- "name": "since",
208
- "summary": "the version number of the previous release. Defaults to the latest-rc version on npm",
209
- "hasDynamicHelp": false,
210
- "multiple": false,
211
- "type": "option"
212
- },
213
- "markdown": {
214
- "char": "m",
215
- "name": "markdown",
216
- "summary": "format the output in markdown",
217
- "allowNo": false,
218
- "type": "boolean"
219
- }
220
- },
221
- "hasDynamicHelp": false,
222
- "hiddenAliases": [],
223
- "id": "cli:releasenotes",
224
- "pluginAlias": "@salesforce/plugin-release-management",
225
- "pluginName": "@salesforce/plugin-release-management",
226
- "pluginType": "core",
227
- "strict": true,
228
- "summary": "pull all relevant information for writing release notes.\nRequires the GH_TOKEN to be set in the environment.",
229
- "enableJsonFlag": true,
230
- "isESM": true,
231
- "relativePath": [
232
- "lib",
233
- "commands",
234
- "cli",
235
- "releasenotes.js"
236
- ]
237
- },
238
164
  "dependabot:automerge": {
239
165
  "aliases": [],
240
166
  "args": {},
@@ -342,6 +268,80 @@
342
268
  "automerge.js"
343
269
  ]
344
270
  },
271
+ "cli:releasenotes": {
272
+ "aliases": [],
273
+ "args": {},
274
+ "description": "pull all relevant information for writing release notes.\nRequires the GH_TOKEN to be set in the environment.",
275
+ "examples": [
276
+ "<%= config.bin %> <%= command.id %> --cli sf",
277
+ "<%= config.bin %> <%= command.id %> --cli sfdx",
278
+ "<%= config.bin %> <%= command.id %> --cli sf --since 1.0.0",
279
+ "<%= config.bin %> <%= command.id %> --cli sfdx --since 7.19.0",
280
+ "<%= config.bin %> <%= command.id %> --cli sf > changes.txt",
281
+ "<%= config.bin %> <%= command.id %> --cli sf --markdown > changes.md"
282
+ ],
283
+ "flags": {
284
+ "json": {
285
+ "description": "Format output as json.",
286
+ "helpGroup": "GLOBAL",
287
+ "name": "json",
288
+ "allowNo": false,
289
+ "type": "boolean"
290
+ },
291
+ "flags-dir": {
292
+ "helpGroup": "GLOBAL",
293
+ "name": "flags-dir",
294
+ "summary": "Import flag values from a directory.",
295
+ "hasDynamicHelp": false,
296
+ "multiple": false,
297
+ "type": "option"
298
+ },
299
+ "cli": {
300
+ "char": "c",
301
+ "name": "cli",
302
+ "required": true,
303
+ "summary": "the cli to pull information for",
304
+ "hasDynamicHelp": false,
305
+ "multiple": false,
306
+ "options": [
307
+ "sf",
308
+ "sfdx"
309
+ ],
310
+ "type": "option"
311
+ },
312
+ "since": {
313
+ "char": "s",
314
+ "name": "since",
315
+ "summary": "the version number of the previous release. Defaults to the latest-rc version on npm",
316
+ "hasDynamicHelp": false,
317
+ "multiple": false,
318
+ "type": "option"
319
+ },
320
+ "markdown": {
321
+ "char": "m",
322
+ "name": "markdown",
323
+ "summary": "format the output in markdown",
324
+ "allowNo": false,
325
+ "type": "boolean"
326
+ }
327
+ },
328
+ "hasDynamicHelp": false,
329
+ "hiddenAliases": [],
330
+ "id": "cli:releasenotes",
331
+ "pluginAlias": "@salesforce/plugin-release-management",
332
+ "pluginName": "@salesforce/plugin-release-management",
333
+ "pluginType": "core",
334
+ "strict": true,
335
+ "summary": "pull all relevant information for writing release notes.\nRequires the GH_TOKEN to be set in the environment.",
336
+ "enableJsonFlag": true,
337
+ "isESM": true,
338
+ "relativePath": [
339
+ "lib",
340
+ "commands",
341
+ "cli",
342
+ "releasenotes.js"
343
+ ]
344
+ },
345
345
  "repositories": {
346
346
  "aliases": [],
347
347
  "args": {},
@@ -461,71 +461,6 @@
461
461
  "index.js"
462
462
  ]
463
463
  },
464
- "cli:artifacts:compare": {
465
- "aliases": [],
466
- "args": {},
467
- "examples": [
468
- "<%= config.bin %> <%= command.id %>"
469
- ],
470
- "flags": {
471
- "json": {
472
- "description": "Format output as json.",
473
- "helpGroup": "GLOBAL",
474
- "name": "json",
475
- "allowNo": false,
476
- "type": "boolean"
477
- },
478
- "flags-dir": {
479
- "helpGroup": "GLOBAL",
480
- "name": "flags-dir",
481
- "summary": "Import flag values from a directory.",
482
- "hasDynamicHelp": false,
483
- "multiple": false,
484
- "type": "option"
485
- },
486
- "plugin": {
487
- "char": "p",
488
- "name": "plugin",
489
- "summary": "List of plugins to check for breaking changes.",
490
- "hasDynamicHelp": false,
491
- "multiple": true,
492
- "type": "option"
493
- },
494
- "previous": {
495
- "char": "r",
496
- "name": "previous",
497
- "summary": "Previous CLI version to compare against. Defaults to the last published version.",
498
- "hasDynamicHelp": false,
499
- "multiple": false,
500
- "type": "option"
501
- },
502
- "current": {
503
- "char": "c",
504
- "name": "current",
505
- "summary": "Current CLI version to compare against. Defaults to the version on the CLI in the current directory.",
506
- "hasDynamicHelp": false,
507
- "multiple": false,
508
- "type": "option"
509
- }
510
- },
511
- "hasDynamicHelp": false,
512
- "hiddenAliases": [],
513
- "id": "cli:artifacts:compare",
514
- "pluginAlias": "@salesforce/plugin-release-management",
515
- "pluginName": "@salesforce/plugin-release-management",
516
- "pluginType": "core",
517
- "strict": true,
518
- "summary": "Look for breaking changes in artifacts (schemas and snapshots) from plugins. Must be run in CLI directory.",
519
- "enableJsonFlag": true,
520
- "isESM": true,
521
- "relativePath": [
522
- "lib",
523
- "commands",
524
- "cli",
525
- "artifacts",
526
- "compare.js"
527
- ]
528
- },
529
464
  "cli:install:test": {
530
465
  "aliases": [],
531
466
  "args": {},
@@ -849,21 +784,12 @@
849
784
  "build.js"
850
785
  ]
851
786
  },
852
- "cli:versions:inspect": {
787
+ "cli:tarballs:prepare": {
853
788
  "aliases": [],
854
789
  "args": {},
855
- "description": "inspect the CLI version across all install paths",
790
+ "description": "remove unnecessary files from node_modules",
856
791
  "examples": [
857
- "<%= config.bin %> <%= command.id %> -l archive -c stable",
858
- "<%= config.bin %> <%= command.id %> -l archive -c stable-rc",
859
- "<%= config.bin %> <%= command.id %> -l archive npm -c stable",
860
- "<%= config.bin %> <%= command.id %> -l archive npm -c latest",
861
- "<%= config.bin %> <%= command.id %> -l archive npm -c latest latest-rc",
862
- "<%= config.bin %> <%= command.id %> -l archive npm -c stable stable-rc",
863
- "<%= config.bin %> <%= command.id %> -l npm -c latest --salesforce",
864
- "<%= config.bin %> <%= command.id %> -l npm -c latest -d @salesforce/core",
865
- "<%= config.bin %> <%= command.id %> -l npm -c latest -d @salesforce/\\*\\*/ salesforce-alm",
866
- "<%= config.bin %> <%= command.id %> -l npm -c latest -d chalk -s"
792
+ "<%= config.bin %> <%= command.id %>"
867
793
  ],
868
794
  "flags": {
869
795
  "json": {
@@ -881,73 +807,158 @@
881
807
  "multiple": false,
882
808
  "type": "option"
883
809
  },
884
- "dependencies": {
810
+ "dryrun": {
885
811
  "char": "d",
886
- "name": "dependencies",
887
- "summary": "glob pattern of dependencies you want to see the version of",
888
- "hasDynamicHelp": false,
889
- "multiple": true,
890
- "type": "option"
812
+ "name": "dryrun",
813
+ "summary": "only show what would be removed from node_modules",
814
+ "allowNo": false,
815
+ "type": "boolean"
891
816
  },
892
- "salesforce": {
893
- "char": "s",
894
- "name": "salesforce",
895
- "summary": "show versions of salesforce owned dependencies",
817
+ "types": {
818
+ "char": "t",
819
+ "name": "types",
820
+ "summary": "remove all types (.d.ts) files from node_modules",
896
821
  "allowNo": false,
897
822
  "type": "boolean"
898
823
  },
899
- "channels": {
900
- "char": "c",
901
- "name": "channels",
902
- "required": true,
903
- "summary": "the channel you want to inspect (for achives, latest and latest-rc are translated to stable and stable-rc. And vice-versa for npm)",
904
- "hasDynamicHelp": false,
905
- "multiple": true,
906
- "options": [
907
- "stable",
908
- "stable-rc",
909
- "latest",
910
- "latest-rc",
911
- "nightly"
912
- ],
824
+ "verbose": {
825
+ "name": "verbose",
826
+ "summary": "show all files paths being removed",
827
+ "allowNo": false,
828
+ "type": "boolean"
829
+ }
830
+ },
831
+ "hasDynamicHelp": false,
832
+ "hiddenAliases": [],
833
+ "id": "cli:tarballs:prepare",
834
+ "pluginAlias": "@salesforce/plugin-release-management",
835
+ "pluginName": "@salesforce/plugin-release-management",
836
+ "pluginType": "core",
837
+ "strict": true,
838
+ "summary": "remove unnecessary files from node_modules",
839
+ "enableJsonFlag": true,
840
+ "isESM": true,
841
+ "relativePath": [
842
+ "lib",
843
+ "commands",
844
+ "cli",
845
+ "tarballs",
846
+ "prepare.js"
847
+ ]
848
+ },
849
+ "cli:tarballs:smoke": {
850
+ "aliases": [],
851
+ "args": {},
852
+ "description": "smoke tests for the sf CLI\nTests that the CLI and every command can be initialized.",
853
+ "examples": [
854
+ "<%= config.bin %> <%= command.id %>",
855
+ "<%= config.bin %> <%= command.id %>"
856
+ ],
857
+ "flags": {
858
+ "json": {
859
+ "description": "Format output as json.",
860
+ "helpGroup": "GLOBAL",
861
+ "name": "json",
862
+ "allowNo": false,
863
+ "type": "boolean"
864
+ },
865
+ "flags-dir": {
866
+ "helpGroup": "GLOBAL",
867
+ "name": "flags-dir",
868
+ "summary": "Import flag values from a directory.",
869
+ "hasDynamicHelp": false,
870
+ "multiple": false,
913
871
  "type": "option"
914
872
  },
915
- "locations": {
916
- "char": "l",
917
- "name": "locations",
918
- "required": true,
919
- "summary": "the location you want to inspect",
873
+ "verbose": {
874
+ "name": "verbose",
875
+ "summary": "show the --help output for each command",
876
+ "allowNo": false,
877
+ "type": "boolean"
878
+ }
879
+ },
880
+ "hasDynamicHelp": false,
881
+ "hiddenAliases": [],
882
+ "id": "cli:tarballs:smoke",
883
+ "pluginAlias": "@salesforce/plugin-release-management",
884
+ "pluginName": "@salesforce/plugin-release-management",
885
+ "pluginType": "core",
886
+ "strict": true,
887
+ "summary": "smoke tests for the sf CLI\nTests that the CLI and every command can be initialized.",
888
+ "enableJsonFlag": true,
889
+ "isESM": true,
890
+ "relativePath": [
891
+ "lib",
892
+ "commands",
893
+ "cli",
894
+ "tarballs",
895
+ "smoke.js"
896
+ ]
897
+ },
898
+ "cli:tarballs:verify": {
899
+ "aliases": [],
900
+ "args": {},
901
+ "description": "verify that tarballs are ready to be uploaded",
902
+ "examples": [
903
+ "<%= config.bin %> <%= command.id %>",
904
+ "<%= config.bin %> <%= command.id %> --cli sfdx",
905
+ "<%= config.bin %> <%= command.id %> --cli sf"
906
+ ],
907
+ "flags": {
908
+ "json": {
909
+ "description": "Format output as json.",
910
+ "helpGroup": "GLOBAL",
911
+ "name": "json",
912
+ "allowNo": false,
913
+ "type": "boolean"
914
+ },
915
+ "flags-dir": {
916
+ "helpGroup": "GLOBAL",
917
+ "name": "flags-dir",
918
+ "summary": "Import flag values from a directory.",
920
919
  "hasDynamicHelp": false,
921
- "multiple": true,
920
+ "multiple": false,
921
+ "type": "option"
922
+ },
923
+ "cli": {
924
+ "char": "c",
925
+ "name": "cli",
926
+ "summary": "the cli to verify",
927
+ "default": "sfdx",
928
+ "hasDynamicHelp": false,
929
+ "multiple": false,
922
930
  "options": [
923
- "archive",
924
- "npm"
931
+ "sf",
932
+ "sfdx"
925
933
  ],
926
934
  "type": "option"
927
935
  },
928
- "ignore-missing": {
929
- "name": "ignore-missing",
930
- "summary": "skip missing archives. Useful when supporting new architectures in oclif",
931
- "allowNo": false,
932
- "type": "boolean"
936
+ "windows-username-buffer": {
937
+ "char": "w",
938
+ "name": "windows-username-buffer",
939
+ "summary": "the number of characters to allow for windows usernames",
940
+ "default": 41,
941
+ "hasDynamicHelp": false,
942
+ "multiple": false,
943
+ "type": "option"
933
944
  }
934
945
  },
935
946
  "hasDynamicHelp": false,
936
947
  "hiddenAliases": [],
937
- "id": "cli:versions:inspect",
948
+ "id": "cli:tarballs:verify",
938
949
  "pluginAlias": "@salesforce/plugin-release-management",
939
950
  "pluginName": "@salesforce/plugin-release-management",
940
951
  "pluginType": "core",
941
952
  "strict": true,
942
- "summary": "inspect the CLI version across all install paths",
953
+ "summary": "verify that tarballs are ready to be uploaded",
943
954
  "enableJsonFlag": true,
944
955
  "isESM": true,
945
956
  "relativePath": [
946
957
  "lib",
947
958
  "commands",
948
959
  "cli",
949
- "versions",
950
- "inspect.js"
960
+ "tarballs",
961
+ "verify.js"
951
962
  ]
952
963
  },
953
964
  "github:check:closed": {
@@ -1011,10 +1022,22 @@
1011
1022
  "closed.js"
1012
1023
  ]
1013
1024
  },
1014
- "npm:dependencies:pin": {
1025
+ "cli:versions:inspect": {
1015
1026
  "aliases": [],
1016
1027
  "args": {},
1017
- "description": "lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry in the package.json",
1028
+ "description": "inspect the CLI version across all install paths",
1029
+ "examples": [
1030
+ "<%= config.bin %> <%= command.id %> -l archive -c stable",
1031
+ "<%= config.bin %> <%= command.id %> -l archive -c stable-rc",
1032
+ "<%= config.bin %> <%= command.id %> -l archive npm -c stable",
1033
+ "<%= config.bin %> <%= command.id %> -l archive npm -c latest",
1034
+ "<%= config.bin %> <%= command.id %> -l archive npm -c latest latest-rc",
1035
+ "<%= config.bin %> <%= command.id %> -l archive npm -c stable stable-rc",
1036
+ "<%= config.bin %> <%= command.id %> -l npm -c latest --salesforce",
1037
+ "<%= config.bin %> <%= command.id %> -l npm -c latest -d @salesforce/core",
1038
+ "<%= config.bin %> <%= command.id %> -l npm -c latest -d @salesforce/\\*\\*/ salesforce-alm",
1039
+ "<%= config.bin %> <%= command.id %> -l npm -c latest -d chalk -s"
1040
+ ],
1018
1041
  "flags": {
1019
1042
  "json": {
1020
1043
  "description": "Format output as json.",
@@ -1031,18 +1054,117 @@
1031
1054
  "multiple": false,
1032
1055
  "type": "option"
1033
1056
  },
1034
- "dryrun": {
1057
+ "dependencies": {
1035
1058
  "char": "d",
1036
- "name": "dryrun",
1037
- "summary": "If true, will not make any changes to the package.json",
1059
+ "name": "dependencies",
1060
+ "summary": "glob pattern of dependencies you want to see the version of",
1061
+ "hasDynamicHelp": false,
1062
+ "multiple": true,
1063
+ "type": "option"
1064
+ },
1065
+ "salesforce": {
1066
+ "char": "s",
1067
+ "name": "salesforce",
1068
+ "summary": "show versions of salesforce owned dependencies",
1038
1069
  "allowNo": false,
1039
1070
  "type": "boolean"
1040
1071
  },
1041
- "tag": {
1042
- "char": "t",
1043
- "name": "tag",
1044
- "summary": "The name of the tag you want, e.g. 'latest-rc', or 'latest'",
1045
- "default": "latest",
1072
+ "channels": {
1073
+ "char": "c",
1074
+ "name": "channels",
1075
+ "required": true,
1076
+ "summary": "the channel you want to inspect (for achives, latest and latest-rc are translated to stable and stable-rc. And vice-versa for npm)",
1077
+ "hasDynamicHelp": false,
1078
+ "multiple": true,
1079
+ "options": [
1080
+ "stable",
1081
+ "stable-rc",
1082
+ "latest",
1083
+ "latest-rc",
1084
+ "nightly"
1085
+ ],
1086
+ "type": "option"
1087
+ },
1088
+ "locations": {
1089
+ "char": "l",
1090
+ "name": "locations",
1091
+ "required": true,
1092
+ "summary": "the location you want to inspect",
1093
+ "hasDynamicHelp": false,
1094
+ "multiple": true,
1095
+ "options": [
1096
+ "archive",
1097
+ "npm"
1098
+ ],
1099
+ "type": "option"
1100
+ },
1101
+ "ignore-missing": {
1102
+ "name": "ignore-missing",
1103
+ "summary": "skip missing archives. Useful when supporting new architectures in oclif",
1104
+ "allowNo": false,
1105
+ "type": "boolean"
1106
+ }
1107
+ },
1108
+ "hasDynamicHelp": false,
1109
+ "hiddenAliases": [],
1110
+ "id": "cli:versions:inspect",
1111
+ "pluginAlias": "@salesforce/plugin-release-management",
1112
+ "pluginName": "@salesforce/plugin-release-management",
1113
+ "pluginType": "core",
1114
+ "strict": true,
1115
+ "summary": "inspect the CLI version across all install paths",
1116
+ "enableJsonFlag": true,
1117
+ "isESM": true,
1118
+ "relativePath": [
1119
+ "lib",
1120
+ "commands",
1121
+ "cli",
1122
+ "versions",
1123
+ "inspect.js"
1124
+ ]
1125
+ },
1126
+ "cli:artifacts:compare": {
1127
+ "aliases": [],
1128
+ "args": {},
1129
+ "examples": [
1130
+ "<%= config.bin %> <%= command.id %>"
1131
+ ],
1132
+ "flags": {
1133
+ "json": {
1134
+ "description": "Format output as json.",
1135
+ "helpGroup": "GLOBAL",
1136
+ "name": "json",
1137
+ "allowNo": false,
1138
+ "type": "boolean"
1139
+ },
1140
+ "flags-dir": {
1141
+ "helpGroup": "GLOBAL",
1142
+ "name": "flags-dir",
1143
+ "summary": "Import flag values from a directory.",
1144
+ "hasDynamicHelp": false,
1145
+ "multiple": false,
1146
+ "type": "option"
1147
+ },
1148
+ "plugin": {
1149
+ "char": "p",
1150
+ "name": "plugin",
1151
+ "summary": "List of plugins to check for breaking changes.",
1152
+ "hasDynamicHelp": false,
1153
+ "multiple": true,
1154
+ "type": "option"
1155
+ },
1156
+ "previous": {
1157
+ "char": "r",
1158
+ "name": "previous",
1159
+ "summary": "Previous CLI version to compare against. Defaults to the last published version.",
1160
+ "hasDynamicHelp": false,
1161
+ "multiple": false,
1162
+ "type": "option"
1163
+ },
1164
+ "current": {
1165
+ "char": "c",
1166
+ "name": "current",
1167
+ "summary": "Current CLI version to compare against. Defaults to the version on the CLI in the current directory.",
1046
1168
  "hasDynamicHelp": false,
1047
1169
  "multiple": false,
1048
1170
  "type": "option"
@@ -1050,20 +1172,20 @@
1050
1172
  },
1051
1173
  "hasDynamicHelp": false,
1052
1174
  "hiddenAliases": [],
1053
- "id": "npm:dependencies:pin",
1175
+ "id": "cli:artifacts:compare",
1054
1176
  "pluginAlias": "@salesforce/plugin-release-management",
1055
1177
  "pluginName": "@salesforce/plugin-release-management",
1056
1178
  "pluginType": "core",
1057
1179
  "strict": true,
1058
- "summary": "lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry in the package.json",
1180
+ "summary": "Look for breaking changes in artifacts (schemas and snapshots) from plugins. Must be run in CLI directory.",
1059
1181
  "enableJsonFlag": true,
1060
1182
  "isESM": true,
1061
1183
  "relativePath": [
1062
1184
  "lib",
1063
1185
  "commands",
1064
- "npm",
1065
- "dependencies",
1066
- "pin.js"
1186
+ "cli",
1187
+ "artifacts",
1188
+ "compare.js"
1067
1189
  ]
1068
1190
  },
1069
1191
  "npm:package:release": {
@@ -1169,13 +1291,10 @@
1169
1291
  "release.js"
1170
1292
  ]
1171
1293
  },
1172
- "cli:tarballs:prepare": {
1294
+ "npm:dependencies:pin": {
1173
1295
  "aliases": [],
1174
1296
  "args": {},
1175
- "description": "remove unnecessary files from node_modules",
1176
- "examples": [
1177
- "<%= config.bin %> <%= command.id %>"
1178
- ],
1297
+ "description": "lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry in the package.json",
1179
1298
  "flags": {
1180
1299
  "json": {
1181
1300
  "description": "Format output as json.",
@@ -1195,134 +1314,15 @@
1195
1314
  "dryrun": {
1196
1315
  "char": "d",
1197
1316
  "name": "dryrun",
1198
- "summary": "only show what would be removed from node_modules",
1317
+ "summary": "If true, will not make any changes to the package.json",
1199
1318
  "allowNo": false,
1200
1319
  "type": "boolean"
1201
1320
  },
1202
- "types": {
1321
+ "tag": {
1203
1322
  "char": "t",
1204
- "name": "types",
1205
- "summary": "remove all types (.d.ts) files from node_modules",
1206
- "allowNo": false,
1207
- "type": "boolean"
1208
- },
1209
- "verbose": {
1210
- "name": "verbose",
1211
- "summary": "show all files paths being removed",
1212
- "allowNo": false,
1213
- "type": "boolean"
1214
- }
1215
- },
1216
- "hasDynamicHelp": false,
1217
- "hiddenAliases": [],
1218
- "id": "cli:tarballs:prepare",
1219
- "pluginAlias": "@salesforce/plugin-release-management",
1220
- "pluginName": "@salesforce/plugin-release-management",
1221
- "pluginType": "core",
1222
- "strict": true,
1223
- "summary": "remove unnecessary files from node_modules",
1224
- "enableJsonFlag": true,
1225
- "isESM": true,
1226
- "relativePath": [
1227
- "lib",
1228
- "commands",
1229
- "cli",
1230
- "tarballs",
1231
- "prepare.js"
1232
- ]
1233
- },
1234
- "cli:tarballs:smoke": {
1235
- "aliases": [],
1236
- "args": {},
1237
- "description": "smoke tests for the sf CLI\nTests that the CLI and every command can be initialized.",
1238
- "examples": [
1239
- "<%= config.bin %> <%= command.id %>",
1240
- "<%= config.bin %> <%= command.id %>"
1241
- ],
1242
- "flags": {
1243
- "json": {
1244
- "description": "Format output as json.",
1245
- "helpGroup": "GLOBAL",
1246
- "name": "json",
1247
- "allowNo": false,
1248
- "type": "boolean"
1249
- },
1250
- "flags-dir": {
1251
- "helpGroup": "GLOBAL",
1252
- "name": "flags-dir",
1253
- "summary": "Import flag values from a directory.",
1254
- "hasDynamicHelp": false,
1255
- "multiple": false,
1256
- "type": "option"
1257
- },
1258
- "verbose": {
1259
- "name": "verbose",
1260
- "summary": "show the --help output for each command",
1261
- "allowNo": false,
1262
- "type": "boolean"
1263
- }
1264
- },
1265
- "hasDynamicHelp": false,
1266
- "hiddenAliases": [],
1267
- "id": "cli:tarballs:smoke",
1268
- "pluginAlias": "@salesforce/plugin-release-management",
1269
- "pluginName": "@salesforce/plugin-release-management",
1270
- "pluginType": "core",
1271
- "strict": true,
1272
- "summary": "smoke tests for the sf CLI\nTests that the CLI and every command can be initialized.",
1273
- "enableJsonFlag": true,
1274
- "isESM": true,
1275
- "relativePath": [
1276
- "lib",
1277
- "commands",
1278
- "cli",
1279
- "tarballs",
1280
- "smoke.js"
1281
- ]
1282
- },
1283
- "cli:tarballs:verify": {
1284
- "aliases": [],
1285
- "args": {},
1286
- "description": "verify that tarballs are ready to be uploaded",
1287
- "examples": [
1288
- "<%= config.bin %> <%= command.id %>",
1289
- "<%= config.bin %> <%= command.id %> --cli sfdx",
1290
- "<%= config.bin %> <%= command.id %> --cli sf"
1291
- ],
1292
- "flags": {
1293
- "json": {
1294
- "description": "Format output as json.",
1295
- "helpGroup": "GLOBAL",
1296
- "name": "json",
1297
- "allowNo": false,
1298
- "type": "boolean"
1299
- },
1300
- "flags-dir": {
1301
- "helpGroup": "GLOBAL",
1302
- "name": "flags-dir",
1303
- "summary": "Import flag values from a directory.",
1304
- "hasDynamicHelp": false,
1305
- "multiple": false,
1306
- "type": "option"
1307
- },
1308
- "cli": {
1309
- "char": "c",
1310
- "name": "cli",
1311
- "summary": "the cli to verify",
1312
- "default": "sfdx",
1313
- "hasDynamicHelp": false,
1314
- "multiple": false,
1315
- "options": [
1316
- "sf",
1317
- "sfdx"
1318
- ],
1319
- "type": "option"
1320
- },
1321
- "windows-username-buffer": {
1322
- "char": "w",
1323
- "name": "windows-username-buffer",
1324
- "summary": "the number of characters to allow for windows usernames",
1325
- "default": 41,
1323
+ "name": "tag",
1324
+ "summary": "The name of the tag you want, e.g. 'latest-rc', or 'latest'",
1325
+ "default": "latest",
1326
1326
  "hasDynamicHelp": false,
1327
1327
  "multiple": false,
1328
1328
  "type": "option"
@@ -1330,20 +1330,20 @@
1330
1330
  },
1331
1331
  "hasDynamicHelp": false,
1332
1332
  "hiddenAliases": [],
1333
- "id": "cli:tarballs:verify",
1333
+ "id": "npm:dependencies:pin",
1334
1334
  "pluginAlias": "@salesforce/plugin-release-management",
1335
1335
  "pluginName": "@salesforce/plugin-release-management",
1336
1336
  "pluginType": "core",
1337
1337
  "strict": true,
1338
- "summary": "verify that tarballs are ready to be uploaded",
1338
+ "summary": "lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry in the package.json",
1339
1339
  "enableJsonFlag": true,
1340
1340
  "isESM": true,
1341
1341
  "relativePath": [
1342
1342
  "lib",
1343
1343
  "commands",
1344
- "cli",
1345
- "tarballs",
1346
- "verify.js"
1344
+ "npm",
1345
+ "dependencies",
1346
+ "pin.js"
1347
1347
  ]
1348
1348
  },
1349
1349
  "cli:install:jit:test": {
@@ -1397,5 +1397,5 @@
1397
1397
  ]
1398
1398
  }
1399
1399
  },
1400
- "version": "6.1.20"
1400
+ "version": "6.1.22"
1401
1401
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-release-management",
3
3
  "description": "A plugin for preparing and publishing npm packages",
4
- "version": "6.1.20",
4
+ "version": "6.1.22",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "type": "module",
@@ -14,7 +14,7 @@
14
14
  "@octokit/core": "^6.1.6",
15
15
  "@octokit/plugin-paginate-rest": "^11.6.0",
16
16
  "@octokit/plugin-throttling": "^9.6.1",
17
- "@salesforce/cli-plugins-testkit": "^5.3.66",
17
+ "@salesforce/cli-plugins-testkit": "^5.3.81",
18
18
  "@salesforce/core": "^9.1.9",
19
19
  "@salesforce/kit": "^4.0.1",
20
20
  "@salesforce/plugin-command-reference": "^3.1.141",
@@ -29,7 +29,7 @@
29
29
  "got": "^13",
30
30
  "just-diff": "^5.2.0",
31
31
  "proxy-agent": "^6.4.0",
32
- "semver": "^7.7.2",
32
+ "semver": "^7.8.6",
33
33
  "shelljs": "^0.10.0",
34
34
  "strip-ansi": "^6",
35
35
  "yarn-deduplicate": "^6.0.2"
@@ -47,7 +47,7 @@
47
47
  "aws-sdk-client-mock": "^4.1.0",
48
48
  "eslint": "^10.12.0",
49
49
  "eslint-config-salesforce-typescript": "^7.0.5",
50
- "eslint-plugin-sf-plugin": "^3.0.0",
50
+ "eslint-plugin-sf-plugin": "^3.0.4",
51
51
  "oclif": "^5.0.2",
52
52
  "ts-node": "^10.9.2",
53
53
  "typescript": "^6.0.0"