@salesforce/plugin-release-management 2.14.0 → 3.0.0

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 (69) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/README.md +293 -324
  3. package/bin/dev +10 -4
  4. package/bin/run +3 -2
  5. package/lib/amazonS3.js +8 -8
  6. package/lib/amazonS3.js.map +1 -1
  7. package/lib/circleCiEnvvars.js +3 -3
  8. package/lib/circleCiEnvvars.js.map +1 -1
  9. package/lib/codeSigning/packAndSign.js +10 -17
  10. package/lib/codeSigning/packAndSign.js.map +1 -1
  11. package/lib/commands/channel/promote.js +8 -13
  12. package/lib/commands/channel/promote.js.map +1 -1
  13. package/lib/commands/circleci/envvar/create.js.map +1 -1
  14. package/lib/commands/circleci/envvar/update.js.map +1 -1
  15. package/lib/commands/cli/install/test.js +17 -5
  16. package/lib/commands/cli/install/test.js.map +1 -1
  17. package/lib/commands/cli/latestrc/build.js +2 -2
  18. package/lib/commands/cli/latestrc/build.js.map +1 -1
  19. package/lib/commands/cli/releasenotes.js +1 -1
  20. package/lib/commands/cli/releasenotes.js.map +1 -1
  21. package/lib/commands/cli/schemas/collect.js +11 -5
  22. package/lib/commands/cli/schemas/collect.js.map +1 -1
  23. package/lib/commands/cli/schemas/compare.js +14 -7
  24. package/lib/commands/cli/schemas/compare.js.map +1 -1
  25. package/lib/commands/cli/tarballs/smoke.js +1 -1
  26. package/lib/commands/cli/tarballs/smoke.js.map +1 -1
  27. package/lib/commands/cli/tarballs/verify.js +44 -22
  28. package/lib/commands/cli/tarballs/verify.js.map +1 -1
  29. package/lib/commands/cli/versions/inspect.js +18 -7
  30. package/lib/commands/cli/versions/inspect.js.map +1 -1
  31. package/lib/commands/dependabot/automerge.js +2 -4
  32. package/lib/commands/dependabot/automerge.js.map +1 -1
  33. package/lib/commands/npm/dependencies/pin.js +4 -6
  34. package/lib/commands/npm/dependencies/pin.js.map +1 -1
  35. package/lib/commands/npm/package/promote.js +3 -7
  36. package/lib/commands/npm/package/promote.js.map +1 -1
  37. package/lib/commands/npm/package/release.js +4 -8
  38. package/lib/commands/npm/package/release.js.map +1 -1
  39. package/lib/commands/npm/release/validate.js +3 -5
  40. package/lib/commands/npm/release/validate.js.map +1 -1
  41. package/lib/commands/repositories/index.js +3 -3
  42. package/lib/commands/repositories/index.js.map +1 -1
  43. package/lib/commands/typescript/update.js +23 -26
  44. package/lib/commands/typescript/update.js.map +1 -1
  45. package/lib/dependabot.js +5 -2
  46. package/lib/dependabot.js.map +1 -1
  47. package/lib/dependencies.d.ts +1 -1
  48. package/lib/inspectCommits.d.ts +1 -1
  49. package/lib/inspectCommits.js +3 -7
  50. package/lib/inspectCommits.js.map +1 -1
  51. package/lib/package.js +10 -4
  52. package/lib/package.js.map +1 -1
  53. package/lib/pluginCommand.js +6 -6
  54. package/lib/pluginCommand.js.map +1 -1
  55. package/lib/registry.js +9 -4
  56. package/lib/registry.js.map +1 -1
  57. package/lib/repository.d.ts +2 -23
  58. package/lib/repository.js +12 -163
  59. package/lib/repository.js.map +1 -1
  60. package/messages/channel.promote.json +0 -1
  61. package/messages/npm.package.promote.json +0 -1
  62. package/messages/npm.package.release.json +1 -2
  63. package/messages/trust.sign.json +1 -1
  64. package/oclif.manifest.json +1 -1
  65. package/package.json +15 -24
  66. package/lib/commands/npm/lerna/release.d.ts +0 -13
  67. package/lib/commands/npm/lerna/release.js +0 -144
  68. package/lib/commands/npm/lerna/release.js.map +0 -1
  69. package/messages/npm.lerna.release.json +0 -14
package/README.md CHANGED
@@ -116,12 +116,11 @@ sfdx plugins
116
116
  - [`sfdx dependabot:automerge -m major|minor|patch [-r <string> -o <string>] [-d] [-s] [--merge-method merge|squash|rebase] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-dependabotautomerge--m-majorminorpatch--r-string--o-string--d--s---merge-method-mergesquashrebase---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
117
117
  - [`sfdx dependabot:consolidate -m major|minor|patch -b <string> -t <string> [--ignore <array>] [-d] [--no-pr] [-r <string> -o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-dependabotconsolidate--m-majorminorpatch--b-string--t-string---ignore-array--d---no-pr--r-string--o-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
118
118
  - [`sfdx npm:dependencies:pin [-d] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-npmdependenciespin--d--t-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
119
- - [`sfdx npm:lerna:release [-d] [-s <array>] [-t <string>] [-a <string>] [--install] [--githubrelease] [--verify] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-npmlernarelease--d--s-array--t-string--a-string---install---githubrelease---verify---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
120
119
  - [`sfdx npm:package:promote -c <string> [-d] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-npmpackagepromote--c-string--d--t-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
121
120
  - [`sfdx npm:package:release [-d] [-s] [-t <string>] [-a <string>] [--install] [--prerelease <string>] [--verify] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-npmpackagerelease--d--s--t-string--a-string---install---prerelease-string---verify---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
122
121
  - [`sfdx npm:release:validate [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-npmreleasevalidate---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
123
122
  - [`sfdx plugins:trust:verify -n <string> [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-pluginstrustverify--n-string--r-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
124
- - [`sfdx `](#sfdx-)
123
+ - [`sfdx`](#sfdx)
125
124
  - [`sfdx typescript:update [-v <string>] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-typescriptupdate--v-string--t-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
126
125
 
127
126
  ## `sfdx channel:promote -t <string> -c sf|sfdx [-d] [-p <array>] [-m <number>] [-i] [-x] [-T <array>] [-T <string> | | [-C <string> | -s <string>]] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
@@ -130,51 +129,42 @@ promote a s3 channel
130
129
 
131
130
  ```
132
131
  USAGE
133
- $ sfdx channel:promote -t <string> -c sf|sfdx [-d] [-p <array>] [-m <number>] [-i] [-x] [-T <array>] [-T <string> | |
134
- [-C <string> | -s <string>]] [--json] [--loglevel
135
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
132
+ $ sfdx channel:promote -t <string> -c sf|sfdx [-d] [-p <array>] [-m <number>] [-i] [-x] [-T <array>] [-T <string> |
133
+ | [-C <string> | -s <string>]] [--json] [--loglevel
134
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
136
135
 
137
- OPTIONS
138
- -C, --candidate=candidate the channel name that you want to
136
+ FLAGS
137
+ -C, --candidate=<value> the channel name that you want to
139
138
  promote
140
-
141
- -T, --targets=targets comma-separated targets to promote
139
+ -T, --targets=<value> comma-separated targets to promote
142
140
  (e.g.: linux-arm,win32-x64)
143
-
144
- -T, --version=version the version of the candidate to be
141
+ -T, --version=<value> the version of the candidate to be
145
142
  promoted, which must exist already
146
143
  in s3. Used to fetch the correct sha
147
-
148
144
  -c, --cli=(sf|sfdx) (required) the cli name to promote
149
-
150
145
  -d, --dryrun If true, only show what would happen
151
-
152
146
  -i, --[no-]indexes append the promoted urls into the
153
147
  index files
154
-
155
- -m, --maxage=maxage [default: 300] cache control max-age
148
+ -m, --maxage=<value> [default: 300] cache control max-age
156
149
  in seconds
157
-
158
- -p, --platform=platform [default: ] the platform to promote
159
-
160
- -s, --sha=sha the short sha to promote
161
-
162
- -t, --target=target (required) [default: stable] the
150
+ -p, --platform=<value>... [default: ] the platform to promote
151
+ -s, --sha=<value> the short sha to promote
152
+ -t, --target=<value> (required) [default: stable] the
163
153
  channel name that you are promoting
164
154
  to
165
-
166
155
  -x, --[no-]xz also upload xz
167
-
168
156
  --json format output as json
169
-
170
157
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
171
158
  this command invocation
172
159
 
173
- EXAMPLE
174
- sfdx channel:promote --candidate latest-rc --target latest --platform win --platform mac
160
+ DESCRIPTION
161
+ promote a s3 channel
162
+
163
+ EXAMPLES
164
+ $ sfdx channel:promote --candidate latest-rc --target latest --platform win --platform mac
175
165
  ```
176
166
 
177
- _See code: [src/commands/channel/promote.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/channel/promote.ts)_
167
+ _See code: [src/commands/channel/promote.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/channel/promote.ts)_
178
168
 
179
169
  ## `sfdx circleci [-t plugin|library|orb] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
180
170
 
@@ -183,20 +173,22 @@ list known Circle CI slugs from 'sfdx repositories'
183
173
  ```
184
174
  USAGE
185
175
  $ sfdx circleci [-t plugin|library|orb] [--json] [--loglevel
186
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
176
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
187
177
 
188
- OPTIONS
178
+ FLAGS
189
179
  -t, --contains-package-type=(plugin|library|orb) filter based on type of package
190
180
  --json format output as json
191
-
192
181
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
193
182
  this command invocation
194
183
 
195
- EXAMPLE
196
- sfdx circleci -t plugin
184
+ DESCRIPTION
185
+ list known Circle CI slugs from 'sfdx repositories'
186
+
187
+ EXAMPLES
188
+ $ sfdx circleci -t plugin
197
189
  ```
198
190
 
199
- _See code: [src/commands/circleci/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/circleci/index.ts)_
191
+ _See code: [src/commands/circleci/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/circleci/index.ts)_
200
192
 
201
193
  ## `sfdx circleci:envvar:create -e <string> [-s <string>] [--dryrun] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
202
194
 
@@ -205,35 +197,35 @@ update environment variable(s) on Circle CI slug(s)
205
197
  ```
206
198
  USAGE
207
199
  $ sfdx circleci:envvar:create -e <string> [-s <string>] [--dryrun] [--json] [--loglevel
208
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
200
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
209
201
 
210
- OPTIONS
211
- -e, --envvar=envvar (required) a environment variables
202
+ FLAGS
203
+ -e, --envvar=<value>... (required) a environment variables
212
204
  to set on the given circle slug(s)
213
-
214
- -s, --slug=slug a circle ci slugs in the format
205
+ -s, --slug=<value>... a circle ci slugs in the format
215
206
  <vcs>/<org name>/<repo name>
216
-
217
207
  --dryrun do validation but do not update the
218
208
  environment variable values
219
-
220
209
  --json format output as json
221
-
222
210
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
223
211
  this command invocation
224
212
 
225
213
  DESCRIPTION
214
+ update environment variable(s) on Circle CI slug(s)
215
+
226
216
  Updates one or more environment variables on one or more CIrcle CI slugs. The environment variables must already exist
227
- on the slug. You will be prompted for the environment variable values unless they already exist on the process. The
217
+ on the slug. You will be prompted for the environment variable values unless they already exist on the process. The
228
218
  slugs can be piped in. If so, the environment variables must be on the process (prompting is disabled).
229
219
 
230
220
  EXAMPLES
231
- sfdx circleci:envvar:create -e 'MY_ENV_VAR' -s 'gh/<org>/<repository>'
221
+ $ sfdx circleci:envvar:create -e 'MY_ENV_VAR' -s 'gh/<org>/<repository>'
222
+
232
223
  echo "gh/<org>/<repository>" | sfdx circleci:envvar:create -e 'MY_ENV_VAR'
233
- sfdx circleci -t plugin | sfdx circleci:envvar:create -e 'MY_ENV_VAR' -e 'MY_OTHER_ENV_VAR'
224
+
225
+ $ sfdx circleci -t plugin | sfdx circleci:envvar:create -e 'MY_ENV_VAR' -e 'MY_OTHER_ENV_VAR'
234
226
  ```
235
227
 
236
- _See code: [src/commands/circleci/envvar/create.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/circleci/envvar/create.ts)_
228
+ _See code: [src/commands/circleci/envvar/create.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/circleci/envvar/create.ts)_
237
229
 
238
230
  ## `sfdx circleci:envvar:update -e <string> [-s <string>] [--dryrun] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
239
231
 
@@ -242,35 +234,35 @@ update environment variable(s) on Circle CI slug(s)
242
234
  ```
243
235
  USAGE
244
236
  $ sfdx circleci:envvar:update -e <string> [-s <string>] [--dryrun] [--json] [--loglevel
245
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
237
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
246
238
 
247
- OPTIONS
248
- -e, --envvar=envvar (required) a environment variables
239
+ FLAGS
240
+ -e, --envvar=<value>... (required) a environment variables
249
241
  to set on the given circle slug(s)
250
-
251
- -s, --slug=slug a circle ci slugs in the format
242
+ -s, --slug=<value>... a circle ci slugs in the format
252
243
  <vcs>/<org name>/<repo name>
253
-
254
244
  --dryrun do validation but do not update the
255
245
  environment variable values
256
-
257
246
  --json format output as json
258
-
259
247
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
260
248
  this command invocation
261
249
 
262
250
  DESCRIPTION
251
+ update environment variable(s) on Circle CI slug(s)
252
+
263
253
  Updates one or more environment variables on one or more CIrcle CI slugs. The environment variables must already exist
264
- on the slug. You will be prompted for the environment variable values unless they already exist on the process. The
254
+ on the slug. You will be prompted for the environment variable values unless they already exist on the process. The
265
255
  slugs can be piped in. If so, the environment variables must be on the process (prompting is disabled).
266
256
 
267
257
  EXAMPLES
268
- sfdx circleci:envvar:update -e 'MY_ENV_VAR' -s 'gh/<org>/<repository>'
258
+ $ sfdx circleci:envvar:update -e 'MY_ENV_VAR' -s 'gh/<org>/<repository>'
259
+
269
260
  echo "gh/<org>/<repository>" | sfdx circleci:envvar:update -e 'MY_ENV_VAR'
270
- sfdx circleci -t plugin | sfdx circleci:envvar:update -e 'MY_ENV_VAR' -e 'MY_OTHER_ENV_VAR'
261
+
262
+ $ sfdx circleci -t plugin | sfdx circleci:envvar:update -e 'MY_ENV_VAR' -e 'MY_OTHER_ENV_VAR'
271
263
  ```
272
264
 
273
- _See code: [src/commands/circleci/envvar/update.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/circleci/envvar/update.ts)_
265
+ _See code: [src/commands/circleci/envvar/update.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/circleci/envvar/update.ts)_
274
266
 
275
267
  ## `sfdx cli:install:test -c <string> -m <string> [--channel <string>] [--output-file <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
276
268
 
@@ -279,35 +271,41 @@ install sf or sfdx
279
271
  ```
280
272
  USAGE
281
273
  $ sfdx cli:install:test -c <string> -m <string> [--channel <string>] [--output-file <string>] [--json] [--loglevel
282
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
274
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
283
275
 
284
- OPTIONS
285
- -c, --cli=sf|sfdx (required) the cli to install
286
-
287
- -m, --method=installer|npm|tarball (required) the installation method
276
+ FLAGS
277
+ -c, --cli=<option> (required) the cli to install
278
+ <options: sf|sfdx>
279
+ -m, --method=<option> (required) the installation method
288
280
  to use
289
-
290
- --channel=legacy|stable|stable-rc|latest|latest-rc [default: stable] the channel to
281
+ <options: installer|npm|tarball>
282
+ --channel=<option> [default: stable] the channel to
291
283
  install from
292
-
284
+ <options: legacy|stable|stable-rc|la
285
+ test|latest-rc>
293
286
  --json format output as json
294
-
295
287
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
296
288
  this command invocation
297
-
298
- --output-file=output-file [default: test-results.json] the
289
+ --output-file=<value> [default: test-results.json] the
299
290
  file to write the JSON results to
300
291
  (must be .json)
301
292
 
293
+ DESCRIPTION
294
+ install sf or sfdx
295
+
302
296
  EXAMPLES
303
- sfdx cli:install:test --cli sfdx --method installer
304
- sfdx cli:install:test --cli sfdx --method npm
305
- sfdx cli:install:test --cli sfdx --method tarball
306
- sfdx cli:install:test --cli sf --method tarball
307
- sfdx cli:install:test --cli sf --method tarball --channel stable-rc
297
+ $ sfdx cli:install:test --cli sfdx --method installer
298
+
299
+ $ sfdx cli:install:test --cli sfdx --method npm
300
+
301
+ $ sfdx cli:install:test --cli sfdx --method tarball
302
+
303
+ $ sfdx cli:install:test --cli sf --method tarball
304
+
305
+ $ sfdx cli:install:test --cli sf --method tarball --channel stable-rc
308
306
  ```
309
307
 
310
- _See code: [src/commands/cli/install/test.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/cli/install/test.ts)_
308
+ _See code: [src/commands/cli/install/test.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/cli/install/test.ts)_
311
309
 
312
310
  ## `sfdx cli:latestrc:build [--rctag <string>] [--build-only] [--resolutions] [--only <array>] [--pinned-deps] [--patch] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
313
311
 
@@ -316,45 +314,44 @@ creates a PR to the repository property defined in the package.json to release a
316
314
  ```
317
315
  USAGE
318
316
  $ sfdx cli:latestrc:build [--rctag <string>] [--build-only] [--resolutions] [--only <array>] [--pinned-deps] [--patch]
319
- [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
317
+ [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
320
318
 
321
- OPTIONS
319
+ FLAGS
322
320
  --build-only only build the latest rc, do not git
323
321
  add/commit/push
324
-
325
322
  --json format output as json
326
-
327
323
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
328
324
  this command invocation
329
-
330
- --only=only only bump the version of the
325
+ --only=<value> only bump the version of the
331
326
  packages passed in, uses latest if
332
327
  version is not provided
333
-
334
328
  --patch bump the release as a patch of an
335
329
  existing version, not a new minor
336
330
  version
337
-
338
331
  --[no-]pinned-deps bump the versions of the packages
339
332
  listed in the pinnedDependencies
340
333
  section
341
-
342
- --rctag=rctag [default: latest-rc] the tag name
334
+ --rctag=<value> [default: latest-rc] the tag name
343
335
  that corresponds to the npm RC
344
336
  build, usually latest-rc or
345
337
  stable-rc
346
-
347
338
  --[no-]resolutions bump the versions of packages listed
348
339
  in the resolutions section
349
340
 
341
+ DESCRIPTION
342
+ creates a PR to the repository property defined in the package.json to release a latest-rc build
343
+
350
344
  EXAMPLES
351
- sfdx cli:latestrc:build
352
- sfdx cli:latestrc:build --patch
353
- sfdx cli:latestrc:build --build-only
354
- sfdx cli:latestrc:build --only @salesforce/plugin-source,@salesforce/plugin-info@1.2.3,@sf/config
345
+ $ sfdx cli:latestrc:build
346
+
347
+ $ sfdx cli:latestrc:build --patch
348
+
349
+ $ sfdx cli:latestrc:build --build-only
350
+
351
+ $ sfdx cli:latestrc:build --only @salesforce/plugin-source,@salesforce/plugin-info@1.2.3,@sf/config
355
352
  ```
356
353
 
357
- _See code: [src/commands/cli/latestrc/build.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/cli/latestrc/build.ts)_
354
+ _See code: [src/commands/cli/latestrc/build.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/cli/latestrc/build.ts)_
358
355
 
359
356
  ## `sfdx cli:releasenotes -c <string> [-s <string>] [-m] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
360
357
 
@@ -363,36 +360,40 @@ pull all relevant information for writing release notes.
363
360
  ```
364
361
  USAGE
365
362
  $ sfdx cli:releasenotes -c <string> [-s <string>] [-m] [--json] [--loglevel
366
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
363
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
367
364
 
368
- OPTIONS
369
- -c, --cli=sf|sfdx (required) the cli to pull
365
+ FLAGS
366
+ -c, --cli=<option> (required) the cli to pull
370
367
  information for
371
-
368
+ <options: sf|sfdx>
372
369
  -m, --markdown format the output in markdown
373
-
374
- -s, --since=since the version number of the previous
370
+ -s, --since=<value> the version number of the previous
375
371
  release. Defaults to the latest-rc
376
372
  version on npm
377
-
378
373
  --json format output as json
379
-
380
374
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
381
375
  this command invocation
382
376
 
383
377
  DESCRIPTION
378
+ pull all relevant information for writing release notes.
379
+
384
380
  Requires the GH_TOKEN to be set in the environment.
385
381
 
386
382
  EXAMPLES
387
- sfdx cli:releasenotes --cli sf
388
- sfdx cli:releasenotes --cli sfdx
389
- sfdx cli:releasenotes --cli sf --since 1.0.0
390
- sfdx cli:releasenotes --cli sfdx --since 7.19.0
391
- sfdx cli:releasenotes --cli sf > changes.txt
392
- sfdx cli:releasenotes --cli sf --markdown > changes.md
383
+ $ sfdx cli:releasenotes --cli sf
384
+
385
+ $ sfdx cli:releasenotes --cli sfdx
386
+
387
+ $ sfdx cli:releasenotes --cli sf --since 1.0.0
388
+
389
+ $ sfdx cli:releasenotes --cli sfdx --since 7.19.0
390
+
391
+ $ sfdx cli:releasenotes --cli sf > changes.txt
392
+
393
+ $ sfdx cli:releasenotes --cli sf --markdown > changes.md
393
394
  ```
394
395
 
395
- _See code: [src/commands/cli/releasenotes.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/cli/releasenotes.ts)_
396
+ _See code: [src/commands/cli/releasenotes.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/cli/releasenotes.ts)_
396
397
 
397
398
  ## `sfdx cli:schemas:collect [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
398
399
 
@@ -402,17 +403,19 @@ collect schemas from installed plugins
402
403
  USAGE
403
404
  $ sfdx cli:schemas:collect [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
404
405
 
405
- OPTIONS
406
+ FLAGS
406
407
  --json format output as json
407
-
408
408
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
409
409
  this command invocation
410
410
 
411
- EXAMPLE
412
- sfdx cli:schemas:collect
411
+ DESCRIPTION
412
+ collect schemas from installed plugins
413
+
414
+ EXAMPLES
415
+ $ sfdx cli:schemas:collect
413
416
  ```
414
417
 
415
- _See code: [src/commands/cli/schemas/collect.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/cli/schemas/collect.ts)_
418
+ _See code: [src/commands/cli/schemas/collect.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/cli/schemas/collect.ts)_
416
419
 
417
420
  ## `sfdx cli:schemas:compare [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
418
421
 
@@ -422,17 +425,19 @@ compare schemas from installed plugins
422
425
  USAGE
423
426
  $ sfdx cli:schemas:compare [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
424
427
 
425
- OPTIONS
428
+ FLAGS
426
429
  --json format output as json
427
-
428
430
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
429
431
  this command invocation
430
432
 
431
- EXAMPLE
432
- sfdx cli:schemas:compare
433
+ DESCRIPTION
434
+ compare schemas from installed plugins
435
+
436
+ EXAMPLES
437
+ $ sfdx cli:schemas:compare
433
438
  ```
434
439
 
435
- _See code: [src/commands/cli/schemas/compare.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/cli/schemas/compare.ts)_
440
+ _See code: [src/commands/cli/schemas/compare.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/cli/schemas/compare.ts)_
436
441
 
437
442
  ## `sfdx cli:tarballs:prepare [-d] [-t] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
438
443
 
@@ -441,27 +446,26 @@ remove unnecessary files from node_modules
441
446
  ```
442
447
  USAGE
443
448
  $ sfdx cli:tarballs:prepare [-d] [-t] [--verbose] [--json] [--loglevel
444
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
449
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
445
450
 
446
- OPTIONS
451
+ FLAGS
447
452
  -d, --dryrun only show what would be removed from
448
453
  node_modules
449
-
450
454
  -t, --types remove all types (.d.ts) files from
451
455
  node_modules
452
-
453
456
  --json format output as json
454
-
455
457
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
456
458
  this command invocation
457
-
458
459
  --verbose show all files paths being removed
459
460
 
460
- EXAMPLE
461
- sfdx cli:tarballs:prepare
461
+ DESCRIPTION
462
+ remove unnecessary files from node_modules
463
+
464
+ EXAMPLES
465
+ $ sfdx cli:tarballs:prepare
462
466
  ```
463
467
 
464
- _See code: [src/commands/cli/tarballs/prepare.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/cli/tarballs/prepare.ts)_
468
+ _See code: [src/commands/cli/tarballs/prepare.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/cli/tarballs/prepare.ts)_
465
469
 
466
470
  ## `sfdx cli:tarballs:smoke -c <string> [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
467
471
 
@@ -470,27 +474,29 @@ smoke tests for the tarballed CLI
470
474
  ```
471
475
  USAGE
472
476
  $ sfdx cli:tarballs:smoke -c <string> [--verbose] [--json] [--loglevel
473
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
477
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
474
478
 
475
- OPTIONS
476
- -c, --cli=sf|sfdx (required) the cli to install
479
+ FLAGS
480
+ -c, --cli=<option> (required) the cli to install
481
+ <options: sf|sfdx>
477
482
  --json format output as json
478
-
479
483
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
480
484
  this command invocation
481
-
482
485
  --verbose show the --help output for each
483
486
  command
484
487
 
485
488
  DESCRIPTION
489
+ smoke tests for the tarballed CLI
490
+
486
491
  Tests that the CLI and every command can be initialized.
487
492
 
488
493
  EXAMPLES
489
- sfdx cli:tarballs:smoke --cli sfdx
490
- sfdx cli:tarballs:smoke --cli sf
494
+ $ sfdx cli:tarballs:smoke --cli sfdx
495
+
496
+ $ sfdx cli:tarballs:smoke --cli sf
491
497
  ```
492
498
 
493
- _See code: [src/commands/cli/tarballs/smoke.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/cli/tarballs/smoke.ts)_
499
+ _See code: [src/commands/cli/tarballs/smoke.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/cli/tarballs/smoke.ts)_
494
500
 
495
501
  ## `sfdx cli:tarballs:verify [-c sf|sfdx] [-w <number>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
496
502
 
@@ -499,27 +505,29 @@ verify that tarballs are ready to be uploaded
499
505
  ```
500
506
  USAGE
501
507
  $ sfdx cli:tarballs:verify [-c sf|sfdx] [-w <number>] [--json] [--loglevel
502
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
508
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
503
509
 
504
- OPTIONS
510
+ FLAGS
505
511
  -c, --cli=(sf|sfdx) [default: sfdx] the cli to verify
506
-
507
- -w, --windows-username-buffer=windows-username-buffer [default: 41] the number of
512
+ -w, --windows-username-buffer=<value> [default: 41] the number of
508
513
  characters to allow for windows
509
514
  usernames
510
-
511
515
  --json format output as json
512
-
513
516
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
514
517
  this command invocation
515
518
 
519
+ DESCRIPTION
520
+ verify that tarballs are ready to be uploaded
521
+
516
522
  EXAMPLES
517
- sfdx cli:tarballs:verify
518
- sfdx cli:tarballs:verify --cli sfdx
519
- sfdx cli:tarballs:verify --cli sf
523
+ $ sfdx cli:tarballs:verify
524
+
525
+ $ sfdx cli:tarballs:verify --cli sfdx
526
+
527
+ $ sfdx cli:tarballs:verify --cli sf
520
528
  ```
521
529
 
522
- _See code: [src/commands/cli/tarballs/verify.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/cli/tarballs/verify.ts)_
530
+ _See code: [src/commands/cli/tarballs/verify.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/cli/tarballs/verify.ts)_
523
531
 
524
532
  ## `sfdx cli:versions:inspect -c <string> -l <string> --cli sf|sfdx [-d <string>] [-s] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
525
533
 
@@ -528,46 +536,59 @@ inspect the CLI version across all install paths
528
536
  ```
529
537
  USAGE
530
538
  $ sfdx cli:versions:inspect -c <string> -l <string> --cli sf|sfdx [-d <string>] [-s] [--json] [--loglevel
531
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
539
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
532
540
 
533
- OPTIONS
534
- -c, --channels=legacy|stable|stable-rc|latest|latest-rc (required) the channel you want to
535
- inspect (for achives, latest and
536
- latest-rc are translated to stable
537
- and stable-rc. And vice-versa for
538
- npm)
541
+ FLAGS
542
+ -c, --channels=<option>...
543
+ (required) the channel you want to inspect (for achives, latest and latest-rc are translated to stable and
544
+ stable-rc. And vice-versa for npm)
545
+ <options: legacy|stable|stable-rc|latest|latest-rc>
539
546
 
540
- -d, --dependencies=dependencies glob pattern of dependencies you
541
- want to see the version of
547
+ -d, --dependencies=<value>...
548
+ glob pattern of dependencies you want to see the version of
542
549
 
543
- -l, --locations=archive|npm (required) the location you want to
544
- inspect
550
+ -l, --locations=<option>...
551
+ (required) the location you want to inspect
552
+ <options: archive|npm>
545
553
 
546
- -s, --salesforce show versions of salesforce owned
547
- dependencies
554
+ -s, --salesforce
555
+ show versions of salesforce owned dependencies
548
556
 
549
- --cli=(sf|sfdx) (required) [default: sfdx] the CLI
550
- you want to inspect
557
+ --cli=(sf|sfdx)
558
+ (required) [default: sfdx] the CLI you want to inspect
551
559
 
552
- --json format output as json
560
+ --json
561
+ format output as json
553
562
 
554
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
555
- this command invocation
563
+ --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)
564
+ [default: warn] logging level for this command invocation
565
+
566
+ DESCRIPTION
567
+ inspect the CLI version across all install paths
556
568
 
557
569
  EXAMPLES
558
- sfdx cli:versions:inspect -l archive -c stable
559
- sfdx cli:versions:inspect -l archive -c stable-rc
560
- sfdx cli:versions:inspect -l archive npm -c stable
561
- sfdx cli:versions:inspect -l archive npm -c latest
562
- sfdx cli:versions:inspect -l archive npm -c latest latest-rc
563
- sfdx cli:versions:inspect -l archive npm -c stable stable-rc
564
- sfdx cli:versions:inspect -l npm -c latest --salesforce
565
- sfdx cli:versions:inspect -l npm -c latest -d @salesforce/core
566
- sfdx cli:versions:inspect -l npm -c latest -d @salesforce/**/ salesforce-alm
567
- sfdx cli:versions:inspect -l npm -c latest -d chalk -s
570
+ $ sfdx cli:versions:inspect -l archive -c stable
571
+
572
+ $ sfdx cli:versions:inspect -l archive -c stable-rc
573
+
574
+ $ sfdx cli:versions:inspect -l archive npm -c stable
575
+
576
+ $ sfdx cli:versions:inspect -l archive npm -c latest
577
+
578
+ $ sfdx cli:versions:inspect -l archive npm -c latest latest-rc
579
+
580
+ $ sfdx cli:versions:inspect -l archive npm -c stable stable-rc
581
+
582
+ $ sfdx cli:versions:inspect -l npm -c latest --salesforce
583
+
584
+ $ sfdx cli:versions:inspect -l npm -c latest -d @salesforce/core
585
+
586
+ $ sfdx cli:versions:inspect -l npm -c latest -d @salesforce/**/ salesforce-alm
587
+
588
+ $ sfdx cli:versions:inspect -l npm -c latest -d chalk -s
568
589
  ```
569
590
 
570
- _See code: [src/commands/cli/versions/inspect.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/cli/versions/inspect.ts)_
591
+ _See code: [src/commands/cli/versions/inspect.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/cli/versions/inspect.ts)_
571
592
 
572
593
  ## `sfdx dependabot:automerge -m major|minor|patch [-r <string> -o <string>] [-d] [-s] [--merge-method merge|squash|rebase] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
573
594
 
@@ -576,42 +597,40 @@ automatically merge one green, mergeable PR up to the specified maximum bump typ
576
597
  ```
577
598
  USAGE
578
599
  $ sfdx dependabot:automerge -m major|minor|patch [-r <string> -o <string>] [-d] [-s] [--merge-method
579
- merge|squash|rebase] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
600
+ merge|squash|rebase] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
580
601
 
581
- OPTIONS
602
+ FLAGS
582
603
  -d, --dryrun only show what would happen if you
583
604
  consolidated dependabot PRs
584
-
585
605
  -m, --max-version-bump=(major|minor|patch) (required) [default: minor] the
586
606
  maximum version bump you want to be
587
607
  included
588
-
589
- -o, --owner=owner the organization that the repository
608
+ -o, --owner=<value> the organization that the repository
590
609
  belongs to. This defaults to the
591
610
  owner specified in the package.json
592
-
593
- -r, --repo=repo the repository you want to
611
+ -r, --repo=<value> the repository you want to
594
612
  consolidate PRs on. This defaults to
595
613
  the repository specified in the
596
614
  package.json
597
-
598
615
  -s, --skip-ci add [skip ci] to the merge commit
599
616
  title
600
-
601
617
  --json format output as json
602
-
603
618
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
604
619
  this command invocation
605
-
606
620
  --merge-method=(merge|squash|rebase) [default: merge] merge method to use
607
621
 
622
+ DESCRIPTION
623
+ automatically merge one green, mergeable PR up to the specified maximum bump type
624
+
608
625
  EXAMPLES
609
- sfdx dependabot:automerge --max-version-bump patch
610
- sfdx dependabot:automerge --max-version-bump minor
611
- sfdx dependabot:automerge --max-version-bump major
626
+ $ sfdx dependabot:automerge --max-version-bump patch
627
+
628
+ $ sfdx dependabot:automerge --max-version-bump minor
629
+
630
+ $ sfdx dependabot:automerge --max-version-bump major
612
631
  ```
613
632
 
614
- _See code: [src/commands/dependabot/automerge.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/dependabot/automerge.ts)_
633
+ _See code: [src/commands/dependabot/automerge.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/dependabot/automerge.ts)_
615
634
 
616
635
  ## `sfdx dependabot:consolidate -m major|minor|patch -b <string> -t <string> [--ignore <array>] [-d] [--no-pr] [-r <string> -o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
617
636
 
@@ -619,50 +638,46 @@ consolidate dependabot PRs into a single PR
619
638
 
620
639
  ```
621
640
  USAGE
622
- $ sfdx dependabot:consolidate -m major|minor|patch -b <string> -t <string> [--ignore <array>] [-d] [--no-pr] [-r
623
- <string> -o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
641
+ $ sfdx dependabot:consolidate -m major|minor|patch -b <string> -t <string> [--ignore <array>] [-d] [--no-pr] [-r <string>
642
+ -o <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
624
643
 
625
- OPTIONS
626
- -b, --base-branch=base-branch (required) [default: main] name of
644
+ FLAGS
645
+ -b, --base-branch=<value> (required) [default: main] name of
627
646
  the base branch for merging
628
-
629
647
  -d, --dryrun only show what would happen if you
630
648
  consolidated dependabot PRs
631
-
632
649
  -m, --max-version-bump=(major|minor|patch) (required) [default: minor] the
633
650
  maximum version bump you want to be
634
651
  included
635
-
636
- -o, --owner=owner the organization that the repository
652
+ -o, --owner=<value> the organization that the repository
637
653
  belongs to. This defaults to the
638
654
  owner specified in the package.json
639
-
640
- -r, --repo=repo the repository you want to
655
+ -r, --repo=<value> the repository you want to
641
656
  consolidate PRs on. This defaults to
642
657
  the repository specified in the
643
658
  package.json
644
-
645
- -t, --target-branch=target-branch (required) [default:
659
+ -t, --target-branch=<value> (required) [default:
646
660
  consolidate-dependabot] name of the
647
661
  target branch for merging
648
-
649
- --ignore=ignore [default: ] ignore any PRs with
662
+ --ignore=<value> [default: ] ignore any PRs with
650
663
  titles that include this value
651
-
652
664
  --json format output as json
653
-
654
665
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
655
666
  this command invocation
656
-
657
667
  --no-pr do everything but create the PR
658
668
 
669
+ DESCRIPTION
670
+ consolidate dependabot PRs into a single PR
671
+
659
672
  EXAMPLES
660
- sfdx dependabot:consolidate --max-version-bump patch
661
- sfdx dependabot:consolidate --max-version-bump minor
662
- sfdx dependabot:consolidate --max-version-bump major
673
+ $ sfdx dependabot:consolidate --max-version-bump patch
674
+
675
+ $ sfdx dependabot:consolidate --max-version-bump minor
676
+
677
+ $ sfdx dependabot:consolidate --max-version-bump major
663
678
  ```
664
679
 
665
- _See code: [src/commands/dependabot/consolidate.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/dependabot/consolidate.ts)_
680
+ _See code: [src/commands/dependabot/consolidate.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/dependabot/consolidate.ts)_
666
681
 
667
682
  ## `sfdx npm:dependencies:pin [-d] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
668
683
 
@@ -671,63 +686,24 @@ lock a list of dependencies to a target tag or default to 'latest', place these
671
686
  ```
672
687
  USAGE
673
688
  $ sfdx npm:dependencies:pin [-d] [-t <string>] [--json] [--loglevel
674
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
689
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
675
690
 
676
- OPTIONS
691
+ FLAGS
677
692
  -d, --dryrun If true, will not make any changes
678
693
  to the package.json
679
-
680
- -t, --tag=tag [default: latest] The name of the
694
+ -t, --tag=<value> [default: latest] The name of the
681
695
  tag you want, e.g. 'latest-rc', or
682
696
  'latest'
683
-
684
697
  --json format output as json
685
-
686
698
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
687
699
  this command invocation
688
- ```
689
-
690
- _See code: [src/commands/npm/dependencies/pin.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/npm/dependencies/pin.ts)_
691
-
692
- ## `sfdx npm:lerna:release [-d] [-s <array>] [-t <string>] [-a <string>] [--install] [--githubrelease] [--verify] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
693
-
694
- publish npm packages from a lerna repository
695
-
696
- ```
697
- USAGE
698
- $ sfdx npm:lerna:release [-d] [-s <array>] [-t <string>] [-a <string>] [--install] [--githubrelease] [--verify]
699
- [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
700
700
 
701
- OPTIONS
702
- -a, --npmaccess=npmaccess [default: public] access level to
703
- use when publishing to npm
704
-
705
- -d, --dryrun if true, will not commit changes to
706
- repo or push any tags
707
-
708
- -s, --sign=sign list of packages to be signed.
709
- Should match the name property of
710
- the package.json
711
-
712
- -t, --npmtag=npmtag [default: latest] tag to use when
713
- publishing to npm
714
-
715
- --githubrelease create release in github based on
716
- the package changes
717
-
718
- --[no-]install run yarn install and build on
719
- repository
720
-
721
- --json format output as json
722
-
723
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
724
- this command invocation
725
-
726
- --[no-]verify verify npm registry has new version
727
- after publish and digital signature
701
+ DESCRIPTION
702
+ lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry
703
+ in the package.json
728
704
  ```
729
705
 
730
- _See code: [src/commands/npm/lerna/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/npm/lerna/release.ts)_
706
+ _See code: [src/commands/npm/dependencies/pin.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/npm/dependencies/pin.ts)_
731
707
 
732
708
  ## `sfdx npm:package:promote -c <string> [-d] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
733
709
 
@@ -736,27 +712,26 @@ promote an npm package
736
712
  ```
737
713
  USAGE
738
714
  $ sfdx npm:package:promote -c <string> [-d] [-t <string>] [--json] [--loglevel
739
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
715
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
740
716
 
741
- OPTIONS
742
- -c, --candidate=candidate (required) the npm tag that you want
717
+ FLAGS
718
+ -c, --candidate=<value> (required) the npm tag that you want
743
719
  to promote
744
-
745
720
  -d, --dryrun If true, only show what would happen
746
-
747
- -t, --target=target [default: latest] the npm tag that
721
+ -t, --target=<value> [default: latest] the npm tag that
748
722
  you are promoting to
749
-
750
723
  --json format output as json
751
-
752
724
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
753
725
  this command invocation
754
726
 
755
- EXAMPLE
756
- sfdx npm:package:promote --candidate latest-rc --target latest
727
+ DESCRIPTION
728
+ promote an npm package
729
+
730
+ EXAMPLES
731
+ $ sfdx npm:package:promote --candidate latest-rc --target latest
757
732
  ```
758
733
 
759
- _See code: [src/commands/npm/package/promote.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/npm/package/promote.ts)_
734
+ _See code: [src/commands/npm/package/promote.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/npm/package/promote.ts)_
760
735
 
761
736
  ## `sfdx npm:package:release [-d] [-s] [-t <string>] [-a <string>] [--install] [--prerelease <string>] [--verify] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
762
737
 
@@ -765,39 +740,34 @@ publish npm package
765
740
  ```
766
741
  USAGE
767
742
  $ sfdx npm:package:release [-d] [-s] [-t <string>] [-a <string>] [--install] [--prerelease <string>] [--verify]
768
- [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
743
+ [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
769
744
 
770
- OPTIONS
771
- -a, --npmaccess=npmaccess [default: public] access level to
745
+ FLAGS
746
+ -a, --npmaccess=<value> [default: public] access level to
772
747
  use when publishing to npm
773
-
774
748
  -d, --dryrun If true, will not commit changes to
775
749
  repo or push any tags
776
-
777
750
  -s, --sign If true, then the package will be
778
751
  signed and the signature will be
779
752
  uploaded to S3
780
-
781
- -t, --npmtag=npmtag [default: latest] tag to use when
753
+ -t, --npmtag=<value> [default: latest] tag to use when
782
754
  publishing to npm
783
-
784
755
  --[no-]install run yarn install and build on
785
756
  repository
786
-
787
757
  --json format output as json
788
-
789
758
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
790
759
  this command invocation
791
-
792
- --prerelease=prerelease determine the next version as
760
+ --prerelease=<value> determine the next version as
793
761
  <version>-<prerelease>.0 if version
794
762
  is not manually set
795
-
796
763
  --[no-]verify verify npm registry has new version
797
764
  after publish and digital signature
765
+
766
+ DESCRIPTION
767
+ publish npm package
798
768
  ```
799
769
 
800
- _See code: [src/commands/npm/package/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/npm/package/release.ts)_
770
+ _See code: [src/commands/npm/package/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/npm/package/release.ts)_
801
771
 
802
772
  ## `sfdx npm:release:validate [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
803
773
 
@@ -806,92 +776,91 @@ inspects the git commits to see if there are any commits that will warrant a new
806
776
  ```
807
777
  USAGE
808
778
  $ sfdx npm:release:validate [--verbose] [--json] [--loglevel
809
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
779
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
810
780
 
811
- OPTIONS
781
+ FLAGS
812
782
  --json format output as json
813
-
814
783
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
815
784
  this command invocation
816
-
817
785
  --verbose show all commits for all packages
818
786
  (only works with --json flag)
787
+
788
+ DESCRIPTION
789
+ inspects the git commits to see if there are any commits that will warrant a new release
819
790
  ```
820
791
 
821
- _See code: [src/commands/npm/release/validate.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/npm/release/validate.ts)_
792
+ _See code: [src/commands/npm/release/validate.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/npm/release/validate.ts)_
822
793
 
823
794
  ## `sfdx plugins:trust:verify -n <string> [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
824
795
 
825
- validate a digital signature for a npm package
796
+ Validate a digital signature for a npm package.
826
797
 
827
798
  ```
828
799
  USAGE
829
800
  $ sfdx plugins:trust:verify -n <string> [-r <string>] [--json] [--loglevel
830
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
831
-
832
- OPTIONS
833
- -n, --npm=npm (required) Specify the npm name.
834
- This can include a tag/version
835
-
836
- -r, --registry=registry The registry name. the behavior is
837
- the same as npm
801
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
838
802
 
803
+ FLAGS
804
+ -n, --npm=<value> (required) Specify the npm name.
805
+ This can include a tag/version.
806
+ -r, --registry=<value> The registry name. The behavior is
807
+ the same as npm.
839
808
  --json format output as json
840
-
841
809
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
842
810
  this command invocation
843
811
 
812
+ DESCRIPTION
813
+ Validate a digital signature for a npm package.
814
+
844
815
  EXAMPLES
845
- sfdx plugins:trust:verify --npm @scope/npmName --registry http://my.repo.org:4874
846
- sfdx plugins:trust:verify --npm @scope/npmName
816
+ $ sfdx plugins:trust:verify --npm @scope/npmName --registry http://my.repo.org:4874
817
+
818
+ $ sfdx plugins:trust:verify --npm @scope/npmName
847
819
  ```
848
820
 
849
- _See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/v1.1.0/src/commands/plugins/trust/verify.ts)_
821
+ _See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/v2.0.3/src/commands/plugins/trust/verify.ts)_
850
822
 
851
- ## `sfdx `
823
+ ## `sfdx`
852
824
 
853
825
  list repositories owned and supported by Salesforce CLI
854
826
 
855
827
  ```
856
828
  USAGE
857
- $ sfdx repositories
829
+ $ sfdx repositories [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
830
+ [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | | [--csv | --no-truncate]]
831
+ [--no-header | ]
858
832
 
859
- OPTIONS
833
+ FLAGS
860
834
  -x, --extended show extra columns
861
-
862
- --columns=columns only show provided columns
835
+ --columns=<value> only show provided columns
863
836
  (comma-separated)
864
-
865
837
  --csv output is csv format [alias:
866
838
  --output=csv]
867
-
868
- --filter=filter filter property by partial string
839
+ --filter=<value> filter property by partial string
869
840
  matching, ex: name=foo
870
-
871
841
  --json format output as json
872
-
873
842
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
874
843
  this command invocation
875
-
876
844
  --no-header hide table header from output
877
-
878
845
  --no-truncate do not truncate output to fit screen
879
-
880
- --output=csv|json|yaml output in a more machine friendly
846
+ --output=<option> output in a more machine friendly
881
847
  format
882
-
883
- --sort=sort property to sort by (prepend '-' for
848
+ <options: csv|json|yaml>
849
+ --sort=<value> property to sort by (prepend '-' for
884
850
  descending)
885
851
 
886
852
  DESCRIPTION
853
+ list repositories owned and supported by Salesforce CLI
854
+
887
855
  For more information on the list of repositories, visit https://github.com/salesforcecli/status.
888
856
 
889
857
  EXAMPLES
890
- sfdx repositories --columns=url --filter='Name=sfdx-core' --no-header | xargs open
891
- sfdx repositories --json | jq -r '.result[] | select(.name=="sfdx-core") | .packages[] | .url
858
+ $ sfdx repositories --columns=url --filter='Name=sfdx-core' --no-header | xargs open
859
+
860
+ $ sfdx repositories --json | jq -r '.result[] | select(.name=="sfdx-core") | .packages[] | .url
892
861
  ```
893
862
 
894
- _See code: [src/commands/repositories/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/repositories/index.ts)_
863
+ _See code: [src/commands/repositories/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/repositories/index.ts)_
895
864
 
896
865
  ## `sfdx typescript:update [-v <string>] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
897
866
 
@@ -900,24 +869,24 @@ Runs tests with updated typescript version and ES target
900
869
  ```
901
870
  USAGE
902
871
  $ sfdx typescript:update [-v <string>] [-t <string>] [--json] [--loglevel
903
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
872
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
904
873
 
905
- OPTIONS
906
- -t, --target=target [default: ESNext] Specify the ES
874
+ FLAGS
875
+ -t, --target=<value> [default: ESNext] Specify the ES
907
876
  target you'd like to use. Defaults
908
877
  to ESNext if not specified
909
-
910
- -v, --version=version [default: latest] Specify the
878
+ -v, --version=<value> [default: latest] Specify the
911
879
  typescript version you'd like to
912
880
  update to. Defaults to latest if not
913
881
  specified
914
-
915
882
  --json format output as json
916
-
917
883
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
918
884
  this command invocation
885
+
886
+ DESCRIPTION
887
+ Runs tests with updated typescript version and ES target
919
888
  ```
920
889
 
921
- _See code: [src/commands/typescript/update.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.1/src/commands/typescript/update.ts)_
890
+ _See code: [src/commands/typescript/update.ts](https://github.com/salesforcecli/plugin-release-management/blob/v3.0.0/src/commands/typescript/update.ts)_
922
891
 
923
892
  <!-- commandsstop -->