@salesforce/plugin-release-management 2.13.1 → 3.0.1

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 (74) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +300 -321
  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 +9 -15
  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 +45 -36
  16. package/lib/commands/cli/install/test.js.map +1 -1
  17. package/lib/commands/cli/latestrc/build.d.ts +1 -0
  18. package/lib/commands/cli/latestrc/build.js +26 -12
  19. package/lib/commands/cli/latestrc/build.js.map +1 -1
  20. package/lib/commands/cli/releasenotes.js +6 -11
  21. package/lib/commands/cli/releasenotes.js.map +1 -1
  22. package/lib/commands/cli/schemas/collect.js +12 -7
  23. package/lib/commands/cli/schemas/collect.js.map +1 -1
  24. package/lib/commands/cli/schemas/compare.js +14 -7
  25. package/lib/commands/cli/schemas/compare.js.map +1 -1
  26. package/lib/commands/cli/tarballs/prepare.js +1 -1
  27. package/lib/commands/cli/tarballs/prepare.js.map +1 -1
  28. package/lib/commands/cli/tarballs/smoke.js +1 -1
  29. package/lib/commands/cli/tarballs/smoke.js.map +1 -1
  30. package/lib/commands/cli/tarballs/verify.js +44 -22
  31. package/lib/commands/cli/tarballs/verify.js.map +1 -1
  32. package/lib/commands/cli/versions/inspect.js +18 -7
  33. package/lib/commands/cli/versions/inspect.js.map +1 -1
  34. package/lib/commands/dependabot/automerge.js +3 -6
  35. package/lib/commands/dependabot/automerge.js.map +1 -1
  36. package/lib/commands/npm/dependencies/pin.js +4 -6
  37. package/lib/commands/npm/dependencies/pin.js.map +1 -1
  38. package/lib/commands/npm/package/promote.js +3 -7
  39. package/lib/commands/npm/package/promote.js.map +1 -1
  40. package/lib/commands/npm/package/release.js +4 -8
  41. package/lib/commands/npm/package/release.js.map +1 -1
  42. package/lib/commands/npm/release/validate.js +3 -5
  43. package/lib/commands/npm/release/validate.js.map +1 -1
  44. package/lib/commands/repositories/index.js +3 -3
  45. package/lib/commands/repositories/index.js.map +1 -1
  46. package/lib/commands/typescript/update.js +23 -26
  47. package/lib/commands/typescript/update.js.map +1 -1
  48. package/lib/dependabot.js +6 -4
  49. package/lib/dependabot.js.map +1 -1
  50. package/lib/dependencies.d.ts +1 -1
  51. package/lib/inspectCommits.d.ts +1 -1
  52. package/lib/inspectCommits.js +3 -7
  53. package/lib/inspectCommits.js.map +1 -1
  54. package/lib/package.d.ts +12 -1
  55. package/lib/package.js +101 -28
  56. package/lib/package.js.map +1 -1
  57. package/lib/pluginCommand.js +8 -9
  58. package/lib/pluginCommand.js.map +1 -1
  59. package/lib/registry.js +14 -11
  60. package/lib/registry.js.map +1 -1
  61. package/lib/repository.d.ts +2 -23
  62. package/lib/repository.js +15 -168
  63. package/lib/repository.js.map +1 -1
  64. package/messages/channel.promote.json +0 -1
  65. package/messages/cli.latestrc.build.json +7 -0
  66. package/messages/npm.package.promote.json +0 -1
  67. package/messages/npm.package.release.json +1 -2
  68. package/messages/trust.sign.json +1 -1
  69. package/oclif.manifest.json +1 -1
  70. package/package.json +15 -24
  71. package/lib/commands/npm/lerna/release.d.ts +0 -13
  72. package/lib/commands/npm/lerna/release.js +0 -144
  73. package/lib/commands/npm/lerna/release.js.map +0 -1
  74. package/messages/npm.lerna.release.json +0 -14
package/README.md CHANGED
@@ -105,7 +105,7 @@ sfdx plugins
105
105
  - [`sfdx circleci:envvar:create -e <string> [-s <string>] [--dryrun] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-circlecienvvarcreate--e-string--s-string---dryrun---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
106
106
  - [`sfdx circleci:envvar:update -e <string> [-s <string>] [--dryrun] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-circlecienvvarupdate--e-string--s-string---dryrun---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
107
107
  - [`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]`](#sfdx-cliinstalltest--c-string--m-string---channel-string---output-file-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
108
- - [`sfdx cli:latestrc:build [--rctag <string>] [--build-only] [--resolutions] [--pinned-deps] [--patch] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-clilatestrcbuild---rctag-string---build-only---resolutions---pinned-deps---patch---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
108
+ - [`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]`](#sfdx-clilatestrcbuild---rctag-string---build-only---resolutions---only-array---pinned-deps---patch---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
109
109
  - [`sfdx cli:releasenotes -c <string> [-s <string>] [-m] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-clireleasenotes--c-string--s-string--m---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
110
110
  - [`sfdx cli:schemas:collect [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-clischemascollect---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
111
111
  - [`sfdx cli:schemas:compare [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-clischemascompare---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
@@ -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.0/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.0/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.0/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.0/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,72 +271,87 @@ 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.0/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
- ## `sfdx cli:latestrc:build [--rctag <string>] [--build-only] [--resolutions] [--pinned-deps] [--patch] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
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
 
314
312
  creates a PR to the repository property defined in the package.json to release a latest-rc build
315
313
 
316
314
  ```
317
315
  USAGE
318
- $ sfdx cli:latestrc:build [--rctag <string>] [--build-only] [--resolutions] [--pinned-deps] [--patch] [--json]
319
- [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
316
+ $ sfdx cli:latestrc:build [--rctag <string>] [--build-only] [--resolutions] [--only <array>] [--pinned-deps] [--patch]
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
-
325
+ --only=<value> only bump the version of the
326
+ packages passed in, uses latest if
327
+ version is not provided
330
328
  --patch bump the release as a patch of an
331
329
  existing version, not a new minor
332
330
  version
333
-
334
331
  --[no-]pinned-deps bump the versions of the packages
335
332
  listed in the pinnedDependencies
336
333
  section
337
-
338
- --rctag=rctag [default: latest-rc] the tag name
334
+ --rctag=<value> [default: latest-rc] the tag name
339
335
  that corresponds to the npm RC
340
336
  build, usually latest-rc or
341
337
  stable-rc
342
-
343
338
  --[no-]resolutions bump the versions of packages listed
344
339
  in the resolutions section
340
+
341
+ DESCRIPTION
342
+ creates a PR to the repository property defined in the package.json to release a latest-rc build
343
+
344
+ EXAMPLES
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
345
352
  ```
346
353
 
347
- _See code: [src/commands/cli/latestrc/build.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
348
355
 
349
356
  ## `sfdx cli:releasenotes -c <string> [-s <string>] [-m] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
350
357
 
@@ -353,36 +360,40 @@ pull all relevant information for writing release notes.
353
360
  ```
354
361
  USAGE
355
362
  $ sfdx cli:releasenotes -c <string> [-s <string>] [-m] [--json] [--loglevel
356
- 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]
357
364
 
358
- OPTIONS
359
- -c, --cli=sf|sfdx (required) the cli to pull
365
+ FLAGS
366
+ -c, --cli=<option> (required) the cli to pull
360
367
  information for
361
-
368
+ <options: sf|sfdx>
362
369
  -m, --markdown format the output in markdown
363
-
364
- -s, --since=since the version number of the previous
370
+ -s, --since=<value> the version number of the previous
365
371
  release. Defaults to the latest-rc
366
372
  version on npm
367
-
368
373
  --json format output as json
369
-
370
374
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
371
375
  this command invocation
372
376
 
373
377
  DESCRIPTION
378
+ pull all relevant information for writing release notes.
379
+
374
380
  Requires the GH_TOKEN to be set in the environment.
375
381
 
376
382
  EXAMPLES
377
- sfdx cli:releasenotes --cli sf
378
- sfdx cli:releasenotes --cli sfdx
379
- sfdx cli:releasenotes --cli sf --since 1.0.0
380
- sfdx cli:releasenotes --cli sfdx --since 7.19.0
381
- sfdx cli:releasenotes --cli sf > changes.txt
382
- 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
383
394
  ```
384
395
 
385
- _See code: [src/commands/cli/releasenotes.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
386
397
 
387
398
  ## `sfdx cli:schemas:collect [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
388
399
 
@@ -392,17 +403,19 @@ collect schemas from installed plugins
392
403
  USAGE
393
404
  $ sfdx cli:schemas:collect [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
394
405
 
395
- OPTIONS
406
+ FLAGS
396
407
  --json format output as json
397
-
398
408
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
399
409
  this command invocation
400
410
 
401
- EXAMPLE
402
- sfdx cli:schemas:collect
411
+ DESCRIPTION
412
+ collect schemas from installed plugins
413
+
414
+ EXAMPLES
415
+ $ sfdx cli:schemas:collect
403
416
  ```
404
417
 
405
- _See code: [src/commands/cli/schemas/collect.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
406
419
 
407
420
  ## `sfdx cli:schemas:compare [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
408
421
 
@@ -412,17 +425,19 @@ compare schemas from installed plugins
412
425
  USAGE
413
426
  $ sfdx cli:schemas:compare [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
414
427
 
415
- OPTIONS
428
+ FLAGS
416
429
  --json format output as json
417
-
418
430
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
419
431
  this command invocation
420
432
 
421
- EXAMPLE
422
- sfdx cli:schemas:compare
433
+ DESCRIPTION
434
+ compare schemas from installed plugins
435
+
436
+ EXAMPLES
437
+ $ sfdx cli:schemas:compare
423
438
  ```
424
439
 
425
- _See code: [src/commands/cli/schemas/compare.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
426
441
 
427
442
  ## `sfdx cli:tarballs:prepare [-d] [-t] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
428
443
 
@@ -431,27 +446,26 @@ remove unnecessary files from node_modules
431
446
  ```
432
447
  USAGE
433
448
  $ sfdx cli:tarballs:prepare [-d] [-t] [--verbose] [--json] [--loglevel
434
- 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]
435
450
 
436
- OPTIONS
451
+ FLAGS
437
452
  -d, --dryrun only show what would be removed from
438
453
  node_modules
439
-
440
454
  -t, --types remove all types (.d.ts) files from
441
455
  node_modules
442
-
443
456
  --json format output as json
444
-
445
457
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
446
458
  this command invocation
447
-
448
459
  --verbose show all files paths being removed
449
460
 
450
- EXAMPLE
451
- sfdx cli:tarballs:prepare
461
+ DESCRIPTION
462
+ remove unnecessary files from node_modules
463
+
464
+ EXAMPLES
465
+ $ sfdx cli:tarballs:prepare
452
466
  ```
453
467
 
454
- _See code: [src/commands/cli/tarballs/prepare.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
455
469
 
456
470
  ## `sfdx cli:tarballs:smoke -c <string> [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
457
471
 
@@ -460,27 +474,29 @@ smoke tests for the tarballed CLI
460
474
  ```
461
475
  USAGE
462
476
  $ sfdx cli:tarballs:smoke -c <string> [--verbose] [--json] [--loglevel
463
- 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]
464
478
 
465
- OPTIONS
466
- -c, --cli=sf|sfdx (required) the cli to install
479
+ FLAGS
480
+ -c, --cli=<option> (required) the cli to install
481
+ <options: sf|sfdx>
467
482
  --json format output as json
468
-
469
483
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
470
484
  this command invocation
471
-
472
485
  --verbose show the --help output for each
473
486
  command
474
487
 
475
488
  DESCRIPTION
489
+ smoke tests for the tarballed CLI
490
+
476
491
  Tests that the CLI and every command can be initialized.
477
492
 
478
493
  EXAMPLES
479
- sfdx cli:tarballs:smoke --cli sfdx
480
- sfdx cli:tarballs:smoke --cli sf
494
+ $ sfdx cli:tarballs:smoke --cli sfdx
495
+
496
+ $ sfdx cli:tarballs:smoke --cli sf
481
497
  ```
482
498
 
483
- _See code: [src/commands/cli/tarballs/smoke.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
484
500
 
485
501
  ## `sfdx cli:tarballs:verify [-c sf|sfdx] [-w <number>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
486
502
 
@@ -489,27 +505,29 @@ verify that tarballs are ready to be uploaded
489
505
  ```
490
506
  USAGE
491
507
  $ sfdx cli:tarballs:verify [-c sf|sfdx] [-w <number>] [--json] [--loglevel
492
- 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]
493
509
 
494
- OPTIONS
510
+ FLAGS
495
511
  -c, --cli=(sf|sfdx) [default: sfdx] the cli to verify
496
-
497
- -w, --windows-username-buffer=windows-username-buffer [default: 41] the number of
512
+ -w, --windows-username-buffer=<value> [default: 41] the number of
498
513
  characters to allow for windows
499
514
  usernames
500
-
501
515
  --json format output as json
502
-
503
516
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
504
517
  this command invocation
505
518
 
519
+ DESCRIPTION
520
+ verify that tarballs are ready to be uploaded
521
+
506
522
  EXAMPLES
507
- sfdx cli:tarballs:verify
508
- sfdx cli:tarballs:verify --cli sfdx
509
- 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
510
528
  ```
511
529
 
512
- _See code: [src/commands/cli/tarballs/verify.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
513
531
 
514
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]`
515
533
 
@@ -518,46 +536,59 @@ inspect the CLI version across all install paths
518
536
  ```
519
537
  USAGE
520
538
  $ sfdx cli:versions:inspect -c <string> -l <string> --cli sf|sfdx [-d <string>] [-s] [--json] [--loglevel
521
- 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]
522
540
 
523
- OPTIONS
524
- -c, --channels=legacy|stable|stable-rc|latest|latest-rc (required) the channel you want to
525
- inspect (for achives, latest and
526
- latest-rc are translated to stable
527
- and stable-rc. And vice-versa for
528
- 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>
529
546
 
530
- -d, --dependencies=dependencies glob pattern of dependencies you
531
- want to see the version of
547
+ -d, --dependencies=<value>...
548
+ glob pattern of dependencies you want to see the version of
532
549
 
533
- -l, --locations=archive|npm (required) the location you want to
534
- inspect
550
+ -l, --locations=<option>...
551
+ (required) the location you want to inspect
552
+ <options: archive|npm>
535
553
 
536
- -s, --salesforce show versions of salesforce owned
537
- dependencies
554
+ -s, --salesforce
555
+ show versions of salesforce owned dependencies
538
556
 
539
- --cli=(sf|sfdx) (required) [default: sfdx] the CLI
540
- you want to inspect
557
+ --cli=(sf|sfdx)
558
+ (required) [default: sfdx] the CLI you want to inspect
541
559
 
542
- --json format output as json
560
+ --json
561
+ format output as json
543
562
 
544
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
545
- 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
546
568
 
547
569
  EXAMPLES
548
- sfdx cli:versions:inspect -l archive -c stable
549
- sfdx cli:versions:inspect -l archive -c stable-rc
550
- sfdx cli:versions:inspect -l archive npm -c stable
551
- sfdx cli:versions:inspect -l archive npm -c latest
552
- sfdx cli:versions:inspect -l archive npm -c latest latest-rc
553
- sfdx cli:versions:inspect -l archive npm -c stable stable-rc
554
- sfdx cli:versions:inspect -l npm -c latest --salesforce
555
- sfdx cli:versions:inspect -l npm -c latest -d @salesforce/core
556
- sfdx cli:versions:inspect -l npm -c latest -d @salesforce/**/ salesforce-alm
557
- 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
558
589
  ```
559
590
 
560
- _See code: [src/commands/cli/versions/inspect.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
561
592
 
562
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]`
563
594
 
@@ -566,42 +597,40 @@ automatically merge one green, mergeable PR up to the specified maximum bump typ
566
597
  ```
567
598
  USAGE
568
599
  $ sfdx dependabot:automerge -m major|minor|patch [-r <string> -o <string>] [-d] [-s] [--merge-method
569
- 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]
570
601
 
571
- OPTIONS
602
+ FLAGS
572
603
  -d, --dryrun only show what would happen if you
573
604
  consolidated dependabot PRs
574
-
575
605
  -m, --max-version-bump=(major|minor|patch) (required) [default: minor] the
576
606
  maximum version bump you want to be
577
607
  included
578
-
579
- -o, --owner=owner the organization that the repository
608
+ -o, --owner=<value> the organization that the repository
580
609
  belongs to. This defaults to the
581
610
  owner specified in the package.json
582
-
583
- -r, --repo=repo the repository you want to
611
+ -r, --repo=<value> the repository you want to
584
612
  consolidate PRs on. This defaults to
585
613
  the repository specified in the
586
614
  package.json
587
-
588
615
  -s, --skip-ci add [skip ci] to the merge commit
589
616
  title
590
-
591
617
  --json format output as json
592
-
593
618
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
594
619
  this command invocation
595
-
596
620
  --merge-method=(merge|squash|rebase) [default: merge] merge method to use
597
621
 
622
+ DESCRIPTION
623
+ automatically merge one green, mergeable PR up to the specified maximum bump type
624
+
598
625
  EXAMPLES
599
- sfdx dependabot:automerge --max-version-bump patch
600
- sfdx dependabot:automerge --max-version-bump minor
601
- 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
602
631
  ```
603
632
 
604
- _See code: [src/commands/dependabot/automerge.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
605
634
 
606
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]`
607
636
 
@@ -609,50 +638,46 @@ consolidate dependabot PRs into a single PR
609
638
 
610
639
  ```
611
640
  USAGE
612
- $ sfdx dependabot:consolidate -m major|minor|patch -b <string> -t <string> [--ignore <array>] [-d] [--no-pr] [-r
613
- <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]
614
643
 
615
- OPTIONS
616
- -b, --base-branch=base-branch (required) [default: main] name of
644
+ FLAGS
645
+ -b, --base-branch=<value> (required) [default: main] name of
617
646
  the base branch for merging
618
-
619
647
  -d, --dryrun only show what would happen if you
620
648
  consolidated dependabot PRs
621
-
622
649
  -m, --max-version-bump=(major|minor|patch) (required) [default: minor] the
623
650
  maximum version bump you want to be
624
651
  included
625
-
626
- -o, --owner=owner the organization that the repository
652
+ -o, --owner=<value> the organization that the repository
627
653
  belongs to. This defaults to the
628
654
  owner specified in the package.json
629
-
630
- -r, --repo=repo the repository you want to
655
+ -r, --repo=<value> the repository you want to
631
656
  consolidate PRs on. This defaults to
632
657
  the repository specified in the
633
658
  package.json
634
-
635
- -t, --target-branch=target-branch (required) [default:
659
+ -t, --target-branch=<value> (required) [default:
636
660
  consolidate-dependabot] name of the
637
661
  target branch for merging
638
-
639
- --ignore=ignore [default: ] ignore any PRs with
662
+ --ignore=<value> [default: ] ignore any PRs with
640
663
  titles that include this value
641
-
642
664
  --json format output as json
643
-
644
665
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
645
666
  this command invocation
646
-
647
667
  --no-pr do everything but create the PR
648
668
 
669
+ DESCRIPTION
670
+ consolidate dependabot PRs into a single PR
671
+
649
672
  EXAMPLES
650
- sfdx dependabot:consolidate --max-version-bump patch
651
- sfdx dependabot:consolidate --max-version-bump minor
652
- 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
653
678
  ```
654
679
 
655
- _See code: [src/commands/dependabot/consolidate.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
656
681
 
657
682
  ## `sfdx npm:dependencies:pin [-d] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
658
683
 
@@ -661,63 +686,24 @@ lock a list of dependencies to a target tag or default to 'latest', place these
661
686
  ```
662
687
  USAGE
663
688
  $ sfdx npm:dependencies:pin [-d] [-t <string>] [--json] [--loglevel
664
- 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]
665
690
 
666
- OPTIONS
691
+ FLAGS
667
692
  -d, --dryrun If true, will not make any changes
668
693
  to the package.json
669
-
670
- -t, --tag=tag [default: latest] The name of the
694
+ -t, --tag=<value> [default: latest] The name of the
671
695
  tag you want, e.g. 'latest-rc', or
672
696
  'latest'
673
-
674
697
  --json format output as json
675
-
676
698
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
677
699
  this command invocation
678
- ```
679
-
680
- _See code: [src/commands/npm/dependencies/pin.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/src/commands/npm/dependencies/pin.ts)_
681
-
682
- ## `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]`
683
-
684
- publish npm packages from a lerna repository
685
-
686
- ```
687
- USAGE
688
- $ sfdx npm:lerna:release [-d] [-s <array>] [-t <string>] [-a <string>] [--install] [--githubrelease] [--verify]
689
- [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
690
700
 
691
- OPTIONS
692
- -a, --npmaccess=npmaccess [default: public] access level to
693
- use when publishing to npm
694
-
695
- -d, --dryrun if true, will not commit changes to
696
- repo or push any tags
697
-
698
- -s, --sign=sign list of packages to be signed.
699
- Should match the name property of
700
- the package.json
701
-
702
- -t, --npmtag=npmtag [default: latest] tag to use when
703
- publishing to npm
704
-
705
- --githubrelease create release in github based on
706
- the package changes
707
-
708
- --[no-]install run yarn install and build on
709
- repository
710
-
711
- --json format output as json
712
-
713
- --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
714
- this command invocation
715
-
716
- --[no-]verify verify npm registry has new version
717
- 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
718
704
  ```
719
705
 
720
- _See code: [src/commands/npm/lerna/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
721
707
 
722
708
  ## `sfdx npm:package:promote -c <string> [-d] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
723
709
 
@@ -726,27 +712,26 @@ promote an npm package
726
712
  ```
727
713
  USAGE
728
714
  $ sfdx npm:package:promote -c <string> [-d] [-t <string>] [--json] [--loglevel
729
- 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]
730
716
 
731
- OPTIONS
732
- -c, --candidate=candidate (required) the npm tag that you want
717
+ FLAGS
718
+ -c, --candidate=<value> (required) the npm tag that you want
733
719
  to promote
734
-
735
720
  -d, --dryrun If true, only show what would happen
736
-
737
- -t, --target=target [default: latest] the npm tag that
721
+ -t, --target=<value> [default: latest] the npm tag that
738
722
  you are promoting to
739
-
740
723
  --json format output as json
741
-
742
724
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
743
725
  this command invocation
744
726
 
745
- EXAMPLE
746
- 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
747
732
  ```
748
733
 
749
- _See code: [src/commands/npm/package/promote.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
750
735
 
751
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]`
752
737
 
@@ -755,39 +740,34 @@ publish npm package
755
740
  ```
756
741
  USAGE
757
742
  $ sfdx npm:package:release [-d] [-s] [-t <string>] [-a <string>] [--install] [--prerelease <string>] [--verify]
758
- [--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]
759
744
 
760
- OPTIONS
761
- -a, --npmaccess=npmaccess [default: public] access level to
745
+ FLAGS
746
+ -a, --npmaccess=<value> [default: public] access level to
762
747
  use when publishing to npm
763
-
764
748
  -d, --dryrun If true, will not commit changes to
765
749
  repo or push any tags
766
-
767
750
  -s, --sign If true, then the package will be
768
751
  signed and the signature will be
769
752
  uploaded to S3
770
-
771
- -t, --npmtag=npmtag [default: latest] tag to use when
753
+ -t, --npmtag=<value> [default: latest] tag to use when
772
754
  publishing to npm
773
-
774
755
  --[no-]install run yarn install and build on
775
756
  repository
776
-
777
757
  --json format output as json
778
-
779
758
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
780
759
  this command invocation
781
-
782
- --prerelease=prerelease determine the next version as
760
+ --prerelease=<value> determine the next version as
783
761
  <version>-<prerelease>.0 if version
784
762
  is not manually set
785
-
786
763
  --[no-]verify verify npm registry has new version
787
764
  after publish and digital signature
765
+
766
+ DESCRIPTION
767
+ publish npm package
788
768
  ```
789
769
 
790
- _See code: [src/commands/npm/package/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
791
771
 
792
772
  ## `sfdx npm:release:validate [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
793
773
 
@@ -796,92 +776,91 @@ inspects the git commits to see if there are any commits that will warrant a new
796
776
  ```
797
777
  USAGE
798
778
  $ sfdx npm:release:validate [--verbose] [--json] [--loglevel
799
- 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]
800
780
 
801
- OPTIONS
781
+ FLAGS
802
782
  --json format output as json
803
-
804
783
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
805
784
  this command invocation
806
-
807
785
  --verbose show all commits for all packages
808
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
809
790
  ```
810
791
 
811
- _See code: [src/commands/npm/release/validate.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
812
793
 
813
794
  ## `sfdx plugins:trust:verify -n <string> [-r <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
814
795
 
815
- validate a digital signature for a npm package
796
+ Validate a digital signature for a npm package.
816
797
 
817
798
  ```
818
799
  USAGE
819
800
  $ sfdx plugins:trust:verify -n <string> [-r <string>] [--json] [--loglevel
820
- trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
821
-
822
- OPTIONS
823
- -n, --npm=npm (required) Specify the npm name.
824
- This can include a tag/version
825
-
826
- -r, --registry=registry The registry name. the behavior is
827
- the same as npm
801
+ trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
828
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.
829
808
  --json format output as json
830
-
831
809
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
832
810
  this command invocation
833
811
 
812
+ DESCRIPTION
813
+ Validate a digital signature for a npm package.
814
+
834
815
  EXAMPLES
835
- sfdx plugins:trust:verify --npm @scope/npmName --registry http://my.repo.org:4874
836
- 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
837
819
  ```
838
820
 
839
- _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)_
840
822
 
841
- ## `sfdx `
823
+ ## `sfdx`
842
824
 
843
825
  list repositories owned and supported by Salesforce CLI
844
826
 
845
827
  ```
846
828
  USAGE
847
- $ 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 | ]
848
832
 
849
- OPTIONS
833
+ FLAGS
850
834
  -x, --extended show extra columns
851
-
852
- --columns=columns only show provided columns
835
+ --columns=<value> only show provided columns
853
836
  (comma-separated)
854
-
855
837
  --csv output is csv format [alias:
856
838
  --output=csv]
857
-
858
- --filter=filter filter property by partial string
839
+ --filter=<value> filter property by partial string
859
840
  matching, ex: name=foo
860
-
861
841
  --json format output as json
862
-
863
842
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
864
843
  this command invocation
865
-
866
844
  --no-header hide table header from output
867
-
868
845
  --no-truncate do not truncate output to fit screen
869
-
870
- --output=csv|json|yaml output in a more machine friendly
846
+ --output=<option> output in a more machine friendly
871
847
  format
872
-
873
- --sort=sort property to sort by (prepend '-' for
848
+ <options: csv|json|yaml>
849
+ --sort=<value> property to sort by (prepend '-' for
874
850
  descending)
875
851
 
876
852
  DESCRIPTION
853
+ list repositories owned and supported by Salesforce CLI
854
+
877
855
  For more information on the list of repositories, visit https://github.com/salesforcecli/status.
878
856
 
879
857
  EXAMPLES
880
- sfdx repositories --columns=url --filter='Name=sfdx-core' --no-header | xargs open
881
- 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
882
861
  ```
883
862
 
884
- _See code: [src/commands/repositories/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
885
864
 
886
865
  ## `sfdx typescript:update [-v <string>] [-t <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
887
866
 
@@ -890,24 +869,24 @@ Runs tests with updated typescript version and ES target
890
869
  ```
891
870
  USAGE
892
871
  $ sfdx typescript:update [-v <string>] [-t <string>] [--json] [--loglevel
893
- 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]
894
873
 
895
- OPTIONS
896
- -t, --target=target [default: ESNext] Specify the ES
874
+ FLAGS
875
+ -t, --target=<value> [default: ESNext] Specify the ES
897
876
  target you'd like to use. Defaults
898
877
  to ESNext if not specified
899
-
900
- -v, --version=version [default: latest] Specify the
878
+ -v, --version=<value> [default: latest] Specify the
901
879
  typescript version you'd like to
902
880
  update to. Defaults to latest if not
903
881
  specified
904
-
905
882
  --json format output as json
906
-
907
883
  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
908
884
  this command invocation
885
+
886
+ DESCRIPTION
887
+ Runs tests with updated typescript version and ES target
909
888
  ```
910
889
 
911
- _See code: [src/commands/typescript/update.ts](https://github.com/salesforcecli/plugin-release-management/blob/v2.13.0/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)_
912
891
 
913
892
  <!-- commandsstop -->