@salesforce/plugin-release-management 4.7.29 → 4.7.30
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.
- package/README.md +9 -596
- package/npm-shrinkwrap.json +11 -11
- package/oclif.lock +10 -10
- package/oclif.manifest.json +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -100,601 +100,14 @@ sfdx plugins
|
|
|
100
100
|
|
|
101
101
|
<!-- commands -->
|
|
102
102
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
- [`sfdx
|
|
106
|
-
- [`sfdx cli
|
|
107
|
-
- [`sfdx
|
|
108
|
-
- [`sfdx
|
|
109
|
-
- [`sfdx
|
|
110
|
-
- [`sfdx
|
|
111
|
-
- [`sfdx
|
|
112
|
-
- [`sfdx cli tarballs verify`](#sfdx-cli-tarballs-verify)
|
|
113
|
-
- [`sfdx cli versions inspect`](#sfdx-cli-versions-inspect)
|
|
114
|
-
- [`sfdx dependabot automerge`](#sfdx-dependabot-automerge)
|
|
115
|
-
- [`sfdx github check closed`](#sfdx-github-check-closed)
|
|
116
|
-
- [`sfdx npm dependencies pin`](#sfdx-npm-dependencies-pin)
|
|
117
|
-
- [`sfdx npm package release`](#sfdx-npm-package-release)
|
|
118
|
-
- [`sfdx plugins trust verify`](#sfdx-plugins-trust-verify)
|
|
119
|
-
- [`sfdx repositories`](#sfdx-repositories)
|
|
120
|
-
|
|
121
|
-
## `sfdx channel promote`
|
|
122
|
-
|
|
123
|
-
promote a s3 channel
|
|
124
|
-
|
|
125
|
-
```
|
|
126
|
-
USAGE
|
|
127
|
-
$ sfdx channel promote -t <value> -c sf|sfdx [--json] [-d] [-C <value>] [-p win|macos|deb] [-s <value>] [-m
|
|
128
|
-
<value>] [-i] [-x] [-T linux-x64|linux-arm|win32-x64|win32-x86|darwin-x64] [-v <value>]
|
|
129
|
-
|
|
130
|
-
FLAGS
|
|
131
|
-
-C, --promote-from-channel=<value> the channel name that you want to promote
|
|
132
|
-
-T, --architecture-target=<option>... comma-separated targets to promote (e.g.: linux-arm,win32-x64)
|
|
133
|
-
<options: linux-x64|linux-arm|win32-x64|win32-x86|darwin-x64>
|
|
134
|
-
-c, --cli=<option> (required) the cli name to promote
|
|
135
|
-
<options: sf|sfdx>
|
|
136
|
-
-d, --dryrun If true, only show what would happen
|
|
137
|
-
-i, --[no-]indexes append the promoted urls into the index files
|
|
138
|
-
-m, --max-age=<value> [default: 300] cache control max-age in seconds
|
|
139
|
-
-p, --platform=<option>... the platform to promote
|
|
140
|
-
<options: win|macos|deb>
|
|
141
|
-
-s, --sha=<value> the short sha to promote
|
|
142
|
-
-t, --promote-to-channel=<value> (required) [default: stable] the channel name that you are promoting to
|
|
143
|
-
-v, --version=<value> the version of the candidate to be promoted, which must exist already in s3.
|
|
144
|
-
Used to fetch the correct sha
|
|
145
|
-
-x, --[no-]xz also upload xz
|
|
146
|
-
|
|
147
|
-
GLOBAL FLAGS
|
|
148
|
-
--json Format output as json.
|
|
149
|
-
|
|
150
|
-
DESCRIPTION
|
|
151
|
-
promote a s3 channel
|
|
152
|
-
|
|
153
|
-
promote a s3 channel
|
|
154
|
-
|
|
155
|
-
EXAMPLES
|
|
156
|
-
$ sfdx channel promote --candidate latest-rc --target latest --platform win --platform mac
|
|
157
|
-
```
|
|
158
|
-
|
|
159
|
-
_See code: [src/commands/channel/promote.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/channel/promote.ts)_
|
|
160
|
-
|
|
161
|
-
## `sfdx cli artifacts compare`
|
|
162
|
-
|
|
163
|
-
Look for breaking changes in artifacts (schemas and snapshots) from plugins. Must be run in CLI directory.
|
|
164
|
-
|
|
165
|
-
```
|
|
166
|
-
USAGE
|
|
167
|
-
$ sfdx cli artifacts compare [--json] [-p <value>] [-r <value>] [-c <value>]
|
|
168
|
-
|
|
169
|
-
FLAGS
|
|
170
|
-
-c, --current=<value> Current CLI version to compare against. Defaults to the version on the CLI in the current
|
|
171
|
-
directory.
|
|
172
|
-
-p, --plugin=<value>... List of plugins to check for breaking changes.
|
|
173
|
-
-r, --previous=<value> Previous CLI version to compare against. Defaults to the last published version.
|
|
174
|
-
|
|
175
|
-
GLOBAL FLAGS
|
|
176
|
-
--json Format output as json.
|
|
177
|
-
|
|
178
|
-
EXAMPLES
|
|
179
|
-
$ sfdx cli artifacts compare
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
_See code: [src/commands/cli/artifacts/compare.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/artifacts/compare.ts)_
|
|
183
|
-
|
|
184
|
-
## `sfdx cli install jit test`
|
|
185
|
-
|
|
186
|
-
Test that all JIT plugins can be successfully installed.
|
|
187
|
-
|
|
188
|
-
```
|
|
189
|
-
USAGE
|
|
190
|
-
$ sfdx cli install jit test [--json] [-j <value>]
|
|
191
|
-
|
|
192
|
-
FLAGS
|
|
193
|
-
-j, --jit-plugin=<value>... JIT plugin(s) to test, example: @salesforce/plugin-community
|
|
194
|
-
|
|
195
|
-
GLOBAL FLAGS
|
|
196
|
-
--json Format output as json.
|
|
197
|
-
|
|
198
|
-
EXAMPLES
|
|
199
|
-
$ sfdx cli install jit test
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
_See code: [src/commands/cli/install/jit/test.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/install/jit/test.ts)_
|
|
203
|
-
|
|
204
|
-
## `sfdx cli install test`
|
|
205
|
-
|
|
206
|
-
install sf or sfdx
|
|
207
|
-
|
|
208
|
-
```
|
|
209
|
-
USAGE
|
|
210
|
-
$ sfdx cli install test -c sf|sfdx -m installer|npm|tarball [--json] [--channel
|
|
211
|
-
legacy|stable|stable-rc|latest|latest-rc] [--output-file <value>]
|
|
212
|
-
|
|
213
|
-
FLAGS
|
|
214
|
-
-c, --cli=<option> (required) the cli to install
|
|
215
|
-
<options: sf|sfdx>
|
|
216
|
-
-m, --method=<option> (required) the installation method to use
|
|
217
|
-
<options: installer|npm|tarball>
|
|
218
|
-
--channel=<option> [default: stable] the channel to install from
|
|
219
|
-
<options: legacy|stable|stable-rc|latest|latest-rc>
|
|
220
|
-
--output-file=<value> [default: test-results.json] the file to write the JSON results to (must be .json)
|
|
221
|
-
|
|
222
|
-
GLOBAL FLAGS
|
|
223
|
-
--json Format output as json.
|
|
224
|
-
|
|
225
|
-
DESCRIPTION
|
|
226
|
-
install sf or sfdx
|
|
227
|
-
|
|
228
|
-
install sf or sfdx
|
|
229
|
-
|
|
230
|
-
EXAMPLES
|
|
231
|
-
$ sfdx cli install test --cli sfdx --method installer
|
|
232
|
-
|
|
233
|
-
$ sfdx cli install test --cli sfdx --method npm
|
|
234
|
-
|
|
235
|
-
$ sfdx cli install test --cli sfdx --method tarball
|
|
236
|
-
|
|
237
|
-
$ sfdx cli install test --cli sf --method tarball
|
|
238
|
-
|
|
239
|
-
$ sfdx cli install test --cli sf --method tarball --channel stable-rc
|
|
240
|
-
```
|
|
241
|
-
|
|
242
|
-
_See code: [src/commands/cli/install/test.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/install/test.ts)_
|
|
243
|
-
|
|
244
|
-
## `sfdx cli release automerge`
|
|
245
|
-
|
|
246
|
-
Attempt to automerge nightly PR
|
|
247
|
-
|
|
248
|
-
```
|
|
249
|
-
USAGE
|
|
250
|
-
$ sfdx cli release automerge (--owner <value> --repo <value>) --pull-number <value> [--json] [-d] [--verbose]
|
|
251
|
-
|
|
252
|
-
FLAGS
|
|
253
|
-
-d, --dry-run Run all checks, but do not merge PR
|
|
254
|
-
--owner=<value> (required) Github owner (org), example: salesforcecli
|
|
255
|
-
--pull-number=<value> (required) Github pull request number to merge
|
|
256
|
-
--repo=<value> (required) Github repo, example: sfdx-cli
|
|
257
|
-
--verbose Show additional debug output
|
|
258
|
-
|
|
259
|
-
GLOBAL FLAGS
|
|
260
|
-
--json Format output as json.
|
|
261
|
-
|
|
262
|
-
DESCRIPTION
|
|
263
|
-
Attempt to automerge nightly PR
|
|
264
|
-
|
|
265
|
-
Attempt to automerge nightly PR
|
|
266
|
-
|
|
267
|
-
EXAMPLES
|
|
268
|
-
$ sfdx cli release automerge --owner salesforcecli --repo sfdx-cli --pul-number 1049
|
|
269
|
-
```
|
|
270
|
-
|
|
271
|
-
_See code: [src/commands/cli/release/automerge.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/release/automerge.ts)_
|
|
272
|
-
|
|
273
|
-
## `sfdx cli release build`
|
|
274
|
-
|
|
275
|
-
builds a new release from a designated starting point and optionally creates PR in Github
|
|
276
|
-
|
|
277
|
-
```
|
|
278
|
-
USAGE
|
|
279
|
-
$ sfdx cli release build -c <value> [--json] [-d <value>] [-g <value>] [--build-only] [--resolutions] [--only
|
|
280
|
-
<value>] [--pinned-deps] [--jit] [--label <value>] [--patch] [--empty] [--pr-base-branch <value>]
|
|
281
|
-
|
|
282
|
-
FLAGS
|
|
283
|
-
-c, --release-channel=<value> (required) the channel intended for this release, examples: nightly, latest-rc,
|
|
284
|
-
latest, dev, beta, etc...
|
|
285
|
-
-d, --start-from-npm-dist-tag=<value> the npm dist-tag to start the release from, examples: nightly, latest-rc
|
|
286
|
-
-g, --start-from-github-ref=<value> a Github ref to start the release from, examples: main, 7.144.0, f476e8e
|
|
287
|
-
--build-only only build the release, do not git add/commit/push
|
|
288
|
-
--empty create an empty release PR for pushing changes to later (version will still be
|
|
289
|
-
bumped)
|
|
290
|
-
--[no-]jit bump the versions of the packages listed in the jitPlugins (just-in-time)
|
|
291
|
-
section
|
|
292
|
-
--label=<value>... add one or more labels to the Github PR
|
|
293
|
-
--only=<value>... only bump the version of the packages passed in, uses latest if version is not
|
|
294
|
-
provided
|
|
295
|
-
--patch bump the release as a patch of an existing version, not a new minor version
|
|
296
|
-
--[no-]pinned-deps bump the versions of the packages listed in the pinnedDependencies section
|
|
297
|
-
--pr-base-branch=<value> base branch to create the PR against; if not specified, the build determines
|
|
298
|
-
the branch for you
|
|
299
|
-
--[no-]resolutions bump the versions of packages listed in the resolutions section
|
|
300
|
-
|
|
301
|
-
GLOBAL FLAGS
|
|
302
|
-
--json Format output as json.
|
|
303
|
-
|
|
304
|
-
DESCRIPTION
|
|
305
|
-
builds a new release from a designated starting point and optionally creates PR in Github
|
|
306
|
-
|
|
307
|
-
builds a new release from a designated starting point and optionally creates PR in Github
|
|
308
|
-
|
|
309
|
-
ALIASES
|
|
310
|
-
$ sfdx cli latestrc build
|
|
311
|
-
|
|
312
|
-
EXAMPLES
|
|
313
|
-
$ sfdx cli release build
|
|
314
|
-
|
|
315
|
-
$ sfdx cli release build --patch
|
|
316
|
-
|
|
317
|
-
$ sfdx cli release build --start-from-npm-dist-tag latest-rc --patch
|
|
318
|
-
|
|
319
|
-
$ sfdx cli release build --start-from-github-ref 7.144.0
|
|
320
|
-
|
|
321
|
-
$ sfdx cli release build --start-from-github-ref main
|
|
322
|
-
|
|
323
|
-
$ sfdx cli release build --start-from-github-ref f476e8e
|
|
324
|
-
|
|
325
|
-
$ sfdx cli release build --start-from-github-ref main --prerelease beta
|
|
326
|
-
|
|
327
|
-
$ sfdx cli release build --build-only
|
|
328
|
-
|
|
329
|
-
$ sfdx cli release build --only @salesforce/plugin-source,@salesforce/plugin-info@1.2.3
|
|
330
|
-
```
|
|
331
|
-
|
|
332
|
-
_See code: [src/commands/cli/release/build.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/release/build.ts)_
|
|
333
|
-
|
|
334
|
-
## `sfdx cli releasenotes`
|
|
335
|
-
|
|
336
|
-
pull all relevant information for writing release notes.
|
|
337
|
-
|
|
338
|
-
```
|
|
339
|
-
USAGE
|
|
340
|
-
$ sfdx cli releasenotes -c sf|sfdx [--json] [-s <value>] [-m]
|
|
341
|
-
|
|
342
|
-
FLAGS
|
|
343
|
-
-c, --cli=<option> (required) the cli to pull information for
|
|
344
|
-
<options: sf|sfdx>
|
|
345
|
-
-m, --markdown format the output in markdown
|
|
346
|
-
-s, --since=<value> the version number of the previous release. Defaults to the latest-rc version on npm
|
|
347
|
-
|
|
348
|
-
GLOBAL FLAGS
|
|
349
|
-
--json Format output as json.
|
|
350
|
-
|
|
351
|
-
DESCRIPTION
|
|
352
|
-
pull all relevant information for writing release notes.
|
|
353
|
-
Requires the GH_TOKEN to be set in the environment.
|
|
354
|
-
|
|
355
|
-
pull all relevant information for writing release notes.
|
|
356
|
-
Requires the GH_TOKEN to be set in the environment.
|
|
357
|
-
|
|
358
|
-
EXAMPLES
|
|
359
|
-
$ sfdx cli releasenotes --cli sf
|
|
360
|
-
|
|
361
|
-
$ sfdx cli releasenotes --cli sfdx
|
|
362
|
-
|
|
363
|
-
$ sfdx cli releasenotes --cli sf --since 1.0.0
|
|
364
|
-
|
|
365
|
-
$ sfdx cli releasenotes --cli sfdx --since 7.19.0
|
|
366
|
-
|
|
367
|
-
$ sfdx cli releasenotes --cli sf > changes.txt
|
|
368
|
-
|
|
369
|
-
$ sfdx cli releasenotes --cli sf --markdown > changes.md
|
|
370
|
-
```
|
|
371
|
-
|
|
372
|
-
_See code: [src/commands/cli/releasenotes.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/releasenotes.ts)_
|
|
373
|
-
|
|
374
|
-
## `sfdx cli tarballs prepare`
|
|
375
|
-
|
|
376
|
-
remove unnecessary files from node_modules
|
|
377
|
-
|
|
378
|
-
```
|
|
379
|
-
USAGE
|
|
380
|
-
$ sfdx cli tarballs prepare [--json] [-d] [-t] [--verbose]
|
|
381
|
-
|
|
382
|
-
FLAGS
|
|
383
|
-
-d, --dryrun only show what would be removed from node_modules
|
|
384
|
-
-t, --types remove all types (.d.ts) files from node_modules
|
|
385
|
-
--verbose show all files paths being removed
|
|
386
|
-
|
|
387
|
-
GLOBAL FLAGS
|
|
388
|
-
--json Format output as json.
|
|
389
|
-
|
|
390
|
-
DESCRIPTION
|
|
391
|
-
remove unnecessary files from node_modules
|
|
392
|
-
|
|
393
|
-
remove unnecessary files from node_modules
|
|
394
|
-
|
|
395
|
-
EXAMPLES
|
|
396
|
-
$ sfdx cli tarballs prepare
|
|
397
|
-
```
|
|
398
|
-
|
|
399
|
-
_See code: [src/commands/cli/tarballs/prepare.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/tarballs/prepare.ts)_
|
|
400
|
-
|
|
401
|
-
## `sfdx cli tarballs smoke`
|
|
402
|
-
|
|
403
|
-
smoke tests for the sf CLI
|
|
404
|
-
|
|
405
|
-
```
|
|
406
|
-
USAGE
|
|
407
|
-
$ sfdx cli tarballs smoke [--json] [--verbose]
|
|
408
|
-
|
|
409
|
-
FLAGS
|
|
410
|
-
--verbose show the --help output for each command
|
|
411
|
-
|
|
412
|
-
GLOBAL FLAGS
|
|
413
|
-
--json Format output as json.
|
|
414
|
-
|
|
415
|
-
DESCRIPTION
|
|
416
|
-
smoke tests for the sf CLI
|
|
417
|
-
Tests that the CLI and every command can be initialized.
|
|
418
|
-
|
|
419
|
-
smoke tests for the sf CLI
|
|
420
|
-
Tests that the CLI and every command can be initialized.
|
|
421
|
-
|
|
422
|
-
EXAMPLES
|
|
423
|
-
$ sfdx cli tarballs smoke
|
|
424
|
-
|
|
425
|
-
$ sfdx cli tarballs smoke
|
|
426
|
-
```
|
|
427
|
-
|
|
428
|
-
_See code: [src/commands/cli/tarballs/smoke.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/tarballs/smoke.ts)_
|
|
429
|
-
|
|
430
|
-
## `sfdx cli tarballs verify`
|
|
431
|
-
|
|
432
|
-
verify that tarballs are ready to be uploaded
|
|
433
|
-
|
|
434
|
-
```
|
|
435
|
-
USAGE
|
|
436
|
-
$ sfdx cli tarballs verify [--json] [-c sf|sfdx] [-w <value>]
|
|
437
|
-
|
|
438
|
-
FLAGS
|
|
439
|
-
-c, --cli=<option> [default: sfdx] the cli to verify
|
|
440
|
-
<options: sf|sfdx>
|
|
441
|
-
-w, --windows-username-buffer=<value> [default: 41] the number of characters to allow for windows usernames
|
|
442
|
-
|
|
443
|
-
GLOBAL FLAGS
|
|
444
|
-
--json Format output as json.
|
|
445
|
-
|
|
446
|
-
DESCRIPTION
|
|
447
|
-
verify that tarballs are ready to be uploaded
|
|
448
|
-
|
|
449
|
-
verify that tarballs are ready to be uploaded
|
|
450
|
-
|
|
451
|
-
EXAMPLES
|
|
452
|
-
$ sfdx cli tarballs verify
|
|
453
|
-
|
|
454
|
-
$ sfdx cli tarballs verify --cli sfdx
|
|
455
|
-
|
|
456
|
-
$ sfdx cli tarballs verify --cli sf
|
|
457
|
-
```
|
|
458
|
-
|
|
459
|
-
_See code: [src/commands/cli/tarballs/verify.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/tarballs/verify.ts)_
|
|
460
|
-
|
|
461
|
-
## `sfdx cli versions inspect`
|
|
462
|
-
|
|
463
|
-
inspect the CLI version across all install paths
|
|
464
|
-
|
|
465
|
-
```
|
|
466
|
-
USAGE
|
|
467
|
-
$ sfdx cli versions inspect -c legacy|stable|stable-rc|latest|latest-rc|nightly -l archive|npm --cli sf|sfdx [--json]
|
|
468
|
-
[-d <value>] [-s]
|
|
469
|
-
|
|
470
|
-
FLAGS
|
|
471
|
-
-c, --channels=<option>... (required) the channel you want to inspect (for achives, latest and latest-rc are
|
|
472
|
-
translated to stable and stable-rc. And vice-versa for npm)
|
|
473
|
-
<options: legacy|stable|stable-rc|latest|latest-rc|nightly>
|
|
474
|
-
-d, --dependencies=<value>... glob pattern of dependencies you want to see the version of
|
|
475
|
-
-l, --locations=<option>... (required) the location you want to inspect
|
|
476
|
-
<options: archive|npm>
|
|
477
|
-
-s, --salesforce show versions of salesforce owned dependencies
|
|
478
|
-
--cli=<option> (required) [default: sfdx] the CLI you want to inspect
|
|
479
|
-
<options: sf|sfdx>
|
|
480
|
-
|
|
481
|
-
GLOBAL FLAGS
|
|
482
|
-
--json Format output as json.
|
|
483
|
-
|
|
484
|
-
DESCRIPTION
|
|
485
|
-
inspect the CLI version across all install paths
|
|
486
|
-
|
|
487
|
-
inspect the CLI version across all install paths
|
|
488
|
-
|
|
489
|
-
EXAMPLES
|
|
490
|
-
$ sfdx cli versions inspect -l archive -c stable
|
|
491
|
-
|
|
492
|
-
$ sfdx cli versions inspect -l archive -c stable-rc
|
|
493
|
-
|
|
494
|
-
$ sfdx cli versions inspect -l archive npm -c stable
|
|
495
|
-
|
|
496
|
-
$ sfdx cli versions inspect -l archive npm -c latest
|
|
497
|
-
|
|
498
|
-
$ sfdx cli versions inspect -l archive npm -c latest latest-rc
|
|
499
|
-
|
|
500
|
-
$ sfdx cli versions inspect -l archive npm -c stable stable-rc
|
|
501
|
-
|
|
502
|
-
$ sfdx cli versions inspect -l npm -c latest --salesforce
|
|
503
|
-
|
|
504
|
-
$ sfdx cli versions inspect -l npm -c latest -d @salesforce/core
|
|
505
|
-
|
|
506
|
-
$ sfdx cli versions inspect -l npm -c latest -d @salesforce/\*\*/ salesforce-alm
|
|
507
|
-
|
|
508
|
-
$ sfdx cli versions inspect -l npm -c latest -d chalk -s
|
|
509
|
-
```
|
|
510
|
-
|
|
511
|
-
_See code: [src/commands/cli/versions/inspect.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/cli/versions/inspect.ts)_
|
|
512
|
-
|
|
513
|
-
## `sfdx dependabot automerge`
|
|
514
|
-
|
|
515
|
-
automatically merge one green, mergeable PR up to the specified maximum bump type
|
|
516
|
-
|
|
517
|
-
```
|
|
518
|
-
USAGE
|
|
519
|
-
$ sfdx dependabot automerge -m major|minor|patch [--json] [-o <value> -r <value>] [-d] [-s] [--merge-method
|
|
520
|
-
merge|squash|rebase]
|
|
521
|
-
|
|
522
|
-
FLAGS
|
|
523
|
-
-d, --dryrun only show what would happen if you consolidated dependabot PRs
|
|
524
|
-
-m, --max-version-bump=<option> (required) [default: minor] the maximum version bump you want to be included
|
|
525
|
-
<options: major|minor|patch>
|
|
526
|
-
-o, --owner=<value> the organization that the repository belongs to. This defaults to the owner specified
|
|
527
|
-
in the package.json
|
|
528
|
-
-r, --repo=<value> the repository you want to consolidate PRs on. This defaults to the repository
|
|
529
|
-
specified in the package.json
|
|
530
|
-
-s, --skip-ci add [skip ci] to the merge commit title
|
|
531
|
-
--merge-method=<option> [default: merge] merge method to use
|
|
532
|
-
<options: merge|squash|rebase>
|
|
533
|
-
|
|
534
|
-
GLOBAL FLAGS
|
|
535
|
-
--json Format output as json.
|
|
536
|
-
|
|
537
|
-
DESCRIPTION
|
|
538
|
-
automatically merge one green, mergeable PR up to the specified maximum bump type
|
|
539
|
-
|
|
540
|
-
automatically merge one green, mergeable PR up to the specified maximum bump type
|
|
541
|
-
|
|
542
|
-
EXAMPLES
|
|
543
|
-
$ sfdx dependabot automerge --max-version-bump patch
|
|
544
|
-
|
|
545
|
-
$ sfdx dependabot automerge --max-version-bump minor
|
|
546
|
-
|
|
547
|
-
$ sfdx dependabot automerge --max-version-bump major
|
|
548
|
-
```
|
|
549
|
-
|
|
550
|
-
_See code: [src/commands/dependabot/automerge.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/dependabot/automerge.ts)_
|
|
551
|
-
|
|
552
|
-
## `sfdx github check closed`
|
|
553
|
-
|
|
554
|
-
Show open Github issues with GUS WI
|
|
555
|
-
|
|
556
|
-
```
|
|
557
|
-
USAGE
|
|
558
|
-
$ sfdx github check closed -o <value> --github-token <value> [--json]
|
|
559
|
-
|
|
560
|
-
FLAGS
|
|
561
|
-
-o, --gus=<value> (required) Username/alias of your GUS org connection
|
|
562
|
-
--github-token=<value> (required) Github token--store this in the environment as GITHUB_TOKEN
|
|
563
|
-
|
|
564
|
-
GLOBAL FLAGS
|
|
565
|
-
--json Format output as json.
|
|
566
|
-
|
|
567
|
-
DESCRIPTION
|
|
568
|
-
Show open Github issues with GUS WI
|
|
569
|
-
|
|
570
|
-
Description of a command.
|
|
571
|
-
|
|
572
|
-
EXAMPLES
|
|
573
|
-
$ sfdx github check closed -o me@gus.com
|
|
574
|
-
```
|
|
575
|
-
|
|
576
|
-
_See code: [src/commands/github/check/closed.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/github/check/closed.ts)_
|
|
577
|
-
|
|
578
|
-
## `sfdx npm dependencies pin`
|
|
579
|
-
|
|
580
|
-
lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry in the package.json
|
|
581
|
-
|
|
582
|
-
```
|
|
583
|
-
USAGE
|
|
584
|
-
$ sfdx npm dependencies pin [--json] [-d] [-t <value>]
|
|
585
|
-
|
|
586
|
-
FLAGS
|
|
587
|
-
-d, --dryrun If true, will not make any changes to the package.json
|
|
588
|
-
-t, --tag=<value> [default: latest] The name of the tag you want, e.g. 'latest-rc', or 'latest'
|
|
589
|
-
|
|
590
|
-
GLOBAL FLAGS
|
|
591
|
-
--json Format output as json.
|
|
592
|
-
|
|
593
|
-
DESCRIPTION
|
|
594
|
-
lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry
|
|
595
|
-
in the package.json
|
|
596
|
-
|
|
597
|
-
lock a list of dependencies to a target tag or default to 'latest', place these entries in 'pinnedDependencies' entry
|
|
598
|
-
in the package.json
|
|
599
|
-
```
|
|
600
|
-
|
|
601
|
-
_See code: [src/commands/npm/dependencies/pin.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/npm/dependencies/pin.ts)_
|
|
602
|
-
|
|
603
|
-
## `sfdx npm package release`
|
|
604
|
-
|
|
605
|
-
publish npm package
|
|
606
|
-
|
|
607
|
-
```
|
|
608
|
-
USAGE
|
|
609
|
-
$ sfdx npm package release [--json] [-d] [-s] [-t <value>] [-a <value>] [--install] [--prerelease <value>] [--verify]
|
|
610
|
-
[--githubtag <value>]
|
|
611
|
-
|
|
612
|
-
FLAGS
|
|
613
|
-
-a, --npmaccess=<value> [default: public] access level to use when publishing to npm
|
|
614
|
-
-d, --dryrun If true, will not commit changes to repo or push any tags
|
|
615
|
-
-s, --sign If true, then the package will be signed and the signature will be uploaded to S3
|
|
616
|
-
-t, --npmtag=<value> [default: latest] tag to use when publishing to npm
|
|
617
|
-
--githubtag=<value> given a github tag, release the version specified in the package.json as is. Useful when
|
|
618
|
-
you've already done a release and only need npm publish features
|
|
619
|
-
--[no-]install run yarn install and build on repository
|
|
620
|
-
--prerelease=<value> determine the next version as <version>-<prerelease>.0 if version is not manually set
|
|
621
|
-
--[no-]verify verify npm registry has new version after publish and digital signature
|
|
622
|
-
|
|
623
|
-
GLOBAL FLAGS
|
|
624
|
-
--json Format output as json.
|
|
625
|
-
|
|
626
|
-
DESCRIPTION
|
|
627
|
-
publish npm package
|
|
628
|
-
|
|
629
|
-
publish npm package
|
|
630
|
-
```
|
|
631
|
-
|
|
632
|
-
_See code: [src/commands/npm/package/release.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/npm/package/release.ts)_
|
|
633
|
-
|
|
634
|
-
## `sfdx plugins trust verify`
|
|
635
|
-
|
|
636
|
-
Validate a digital signature.
|
|
637
|
-
|
|
638
|
-
```
|
|
639
|
-
USAGE
|
|
640
|
-
$ sfdx plugins trust verify -n <value> [--json] [-r <value>]
|
|
641
|
-
|
|
642
|
-
FLAGS
|
|
643
|
-
-n, --npm=<value> (required) Specify the npm name. This can include a tag/version.
|
|
644
|
-
-r, --registry=<value> The registry name. The behavior is the same as npm.
|
|
645
|
-
|
|
646
|
-
GLOBAL FLAGS
|
|
647
|
-
--json Format output as json.
|
|
648
|
-
|
|
649
|
-
DESCRIPTION
|
|
650
|
-
Validate a digital signature.
|
|
651
|
-
|
|
652
|
-
Verifies the digital signature on an npm package matches the signature and key stored at the expected URLs.
|
|
653
|
-
|
|
654
|
-
EXAMPLES
|
|
655
|
-
$ sfdx plugins trust verify --npm @scope/npmName --registry https://npm.pkg.github.com
|
|
656
|
-
|
|
657
|
-
$ sfdx plugins trust verify --npm @scope/npmName
|
|
658
|
-
```
|
|
659
|
-
|
|
660
|
-
_See code: [@salesforce/plugin-trust](https://github.com/salesforcecli/plugin-trust/blob/3.3.16/src/commands/plugins/trust/verify.ts)_
|
|
661
|
-
|
|
662
|
-
## `sfdx repositories`
|
|
663
|
-
|
|
664
|
-
list repositories owned and supported by Salesforce CLI
|
|
665
|
-
|
|
666
|
-
```
|
|
667
|
-
USAGE
|
|
668
|
-
$ sfdx repositories [--json] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]]
|
|
669
|
-
[--output csv|json|yaml | | ] [--sort <value>]
|
|
670
|
-
|
|
671
|
-
FLAGS
|
|
672
|
-
-x, --extended show extra columns
|
|
673
|
-
--columns=<value> only show provided columns (comma-separated)
|
|
674
|
-
--csv output is csv format [alias: --output=csv]
|
|
675
|
-
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
676
|
-
--no-header hide table header from output
|
|
677
|
-
--no-truncate do not truncate output to fit screen
|
|
678
|
-
--output=<option> output in a more machine friendly format
|
|
679
|
-
<options: csv|json|yaml>
|
|
680
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
681
|
-
|
|
682
|
-
GLOBAL FLAGS
|
|
683
|
-
--json Format output as json.
|
|
684
|
-
|
|
685
|
-
DESCRIPTION
|
|
686
|
-
list repositories owned and supported by Salesforce CLI
|
|
687
|
-
For more information on the list of repositories, visit https://github.com/salesforcecli/status.
|
|
688
|
-
|
|
689
|
-
list repositories owned and supported by Salesforce CLI
|
|
690
|
-
For more information on the list of repositories, visit https://github.com/salesforcecli/status.
|
|
691
|
-
|
|
692
|
-
EXAMPLES
|
|
693
|
-
$ sfdx repositories --columns=url --filter='Name=sfdx-core' --no-header | xargs open
|
|
694
|
-
|
|
695
|
-
$ sfdx repositories --json | jq -r '.result[] | select(.name=="sfdx-core") | .packages[] | .url
|
|
696
|
-
```
|
|
697
|
-
|
|
698
|
-
_See code: [src/commands/repositories/index.ts](https://github.com/salesforcecli/plugin-release-management/blob/4.7.29/src/commands/repositories/index.ts)_
|
|
103
|
+
# Command Topics
|
|
104
|
+
|
|
105
|
+
- [`sfdx channel`](docs/channel.md) - interact with aws channels for clis
|
|
106
|
+
- [`sfdx cli`](docs/cli.md) - get information on the cli
|
|
107
|
+
- [`sfdx dependabot`](docs/dependabot.md) - interact with dependabot PRs
|
|
108
|
+
- [`sfdx github`](docs/github.md) - interact with github issues
|
|
109
|
+
- [`sfdx npm`](docs/npm.md) - release npm packages
|
|
110
|
+
- [`sfdx plugins`](docs/plugins.md) - list installed plugins
|
|
111
|
+
- [`sfdx repositories`](docs/repositories.md) - list and get information about SalesforceCLI-owned repositories
|
|
699
112
|
|
|
700
113
|
<!-- commandsstop -->
|
package/npm-shrinkwrap.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-release-management",
|
|
3
|
-
"version": "4.7.
|
|
3
|
+
"version": "4.7.30",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@salesforce/plugin-release-management",
|
|
9
|
-
"version": "4.7.
|
|
9
|
+
"version": "4.7.30",
|
|
10
10
|
"license": "BSD-3-Clause",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@oclif/core": "^3.18.2",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"@salesforce/core": "^6.7.1",
|
|
18
18
|
"@salesforce/kit": "^3.0.15",
|
|
19
19
|
"@salesforce/plugin-command-reference": "^3.0.70",
|
|
20
|
-
"@salesforce/plugin-trust": "^3.3.
|
|
20
|
+
"@salesforce/plugin-trust": "^3.3.17",
|
|
21
21
|
"@salesforce/sf-plugins-core": "^7.1.15",
|
|
22
22
|
"@salesforce/ts-types": "^2.0.9",
|
|
23
23
|
"aws-sdk": "^2.1579.0",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"eslint-plugin-sf-plugin": "^1.17.4",
|
|
46
46
|
"oclif": "^4.5.4",
|
|
47
47
|
"ts-node": "^10.9.2",
|
|
48
|
-
"typescript": "^5.4.
|
|
48
|
+
"typescript": "^5.4.3"
|
|
49
49
|
},
|
|
50
50
|
"engines": {
|
|
51
51
|
"node": ">=16.0.0"
|
|
@@ -4001,14 +4001,14 @@
|
|
|
4001
4001
|
}
|
|
4002
4002
|
},
|
|
4003
4003
|
"node_modules/@salesforce/plugin-trust": {
|
|
4004
|
-
"version": "3.3.
|
|
4005
|
-
"resolved": "https://registry.npmjs.org/@salesforce/plugin-trust/-/plugin-trust-3.3.
|
|
4006
|
-
"integrity": "sha512-
|
|
4004
|
+
"version": "3.3.17",
|
|
4005
|
+
"resolved": "https://registry.npmjs.org/@salesforce/plugin-trust/-/plugin-trust-3.3.17.tgz",
|
|
4006
|
+
"integrity": "sha512-sxXNOw+ZrLxxoToWN5CCn5ZT1+gOAV53HeCTE3w1InxWMrhKIe95dHzci/YbJD/9pIGZsfKZ3bre83oL0nIgHQ==",
|
|
4007
4007
|
"license": "BSD-3-Clause",
|
|
4008
4008
|
"dependencies": {
|
|
4009
4009
|
"@oclif/core": "^3.20.0",
|
|
4010
4010
|
"@salesforce/core": "^6.5.5",
|
|
4011
|
-
"@salesforce/sf-plugins-core": "^7.1.
|
|
4011
|
+
"@salesforce/sf-plugins-core": "^7.1.15",
|
|
4012
4012
|
"got": "^13.0.0",
|
|
4013
4013
|
"npm": "10.2.3",
|
|
4014
4014
|
"npm-run-path": "^4.0.1",
|
|
@@ -21179,9 +21179,9 @@
|
|
|
21179
21179
|
}
|
|
21180
21180
|
},
|
|
21181
21181
|
"node_modules/typescript": {
|
|
21182
|
-
"version": "5.4.
|
|
21183
|
-
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.
|
|
21184
|
-
"integrity": "sha512
|
|
21182
|
+
"version": "5.4.3",
|
|
21183
|
+
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.3.tgz",
|
|
21184
|
+
"integrity": "sha512-KrPd3PKaCLr78MalgiwJnA25Nm8HAmdwN3mYUYZgG/wizIo9EainNVQI9/yDavtVFRN2h3k8uf3GLHuhDMgEHg==",
|
|
21185
21185
|
"dev": true,
|
|
21186
21186
|
"license": "Apache-2.0",
|
|
21187
21187
|
"bin": {
|
package/oclif.lock
CHANGED
|
@@ -1999,14 +1999,14 @@
|
|
|
1999
1999
|
handlebars "^4.7.8"
|
|
2000
2000
|
tslib "^2"
|
|
2001
2001
|
|
|
2002
|
-
"@salesforce/plugin-trust@^3.3.
|
|
2003
|
-
version "3.3.
|
|
2004
|
-
resolved "https://registry.yarnpkg.com/@salesforce/plugin-trust/-/plugin-trust-3.3.
|
|
2005
|
-
integrity sha512-
|
|
2002
|
+
"@salesforce/plugin-trust@^3.3.17":
|
|
2003
|
+
version "3.3.17"
|
|
2004
|
+
resolved "https://registry.yarnpkg.com/@salesforce/plugin-trust/-/plugin-trust-3.3.17.tgz#ecda65c6c17be99dbb1872be661d306505e69465"
|
|
2005
|
+
integrity sha512-sxXNOw+ZrLxxoToWN5CCn5ZT1+gOAV53HeCTE3w1InxWMrhKIe95dHzci/YbJD/9pIGZsfKZ3bre83oL0nIgHQ==
|
|
2006
2006
|
dependencies:
|
|
2007
2007
|
"@oclif/core" "^3.20.0"
|
|
2008
2008
|
"@salesforce/core" "^6.5.5"
|
|
2009
|
-
"@salesforce/sf-plugins-core" "^7.1.
|
|
2009
|
+
"@salesforce/sf-plugins-core" "^7.1.15"
|
|
2010
2010
|
got "^13.0.0"
|
|
2011
2011
|
npm "10.2.3"
|
|
2012
2012
|
npm-run-path "^4.0.1"
|
|
@@ -2037,7 +2037,7 @@
|
|
|
2037
2037
|
chalk "^4"
|
|
2038
2038
|
inquirer "^8.2.5"
|
|
2039
2039
|
|
|
2040
|
-
"@salesforce/sf-plugins-core@^7.1.
|
|
2040
|
+
"@salesforce/sf-plugins-core@^7.1.15":
|
|
2041
2041
|
version "7.1.15"
|
|
2042
2042
|
resolved "https://registry.yarnpkg.com/@salesforce/sf-plugins-core/-/sf-plugins-core-7.1.15.tgz#4d6033d56d78cf6046abfce96c119a8a60ee7c07"
|
|
2043
2043
|
integrity sha512-dQSSIHEpeFIadkWqZE24068m01vy31hVJdGWYvgscTnNrR30jIC5fXRevYvGG0l+8vVEJkCYYnJFQabUjSw3Eg==
|
|
@@ -10368,10 +10368,10 @@ typedoc@^0.25.9:
|
|
|
10368
10368
|
minimatch "^9.0.3"
|
|
10369
10369
|
shiki "^0.14.7"
|
|
10370
10370
|
|
|
10371
|
-
"typescript@^4.6.4 || ^5.0.0", typescript@^5.4.
|
|
10372
|
-
version "5.4.
|
|
10373
|
-
resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.4.
|
|
10374
|
-
integrity sha512
|
|
10371
|
+
"typescript@^4.6.4 || ^5.0.0", typescript@^5.4.3:
|
|
10372
|
+
version "5.4.3"
|
|
10373
|
+
resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.4.3.tgz#5c6fedd4c87bee01cd7a528a30145521f8e0feff"
|
|
10374
|
+
integrity sha512-KrPd3PKaCLr78MalgiwJnA25Nm8HAmdwN3mYUYZgG/wizIo9EainNVQI9/yDavtVFRN2h3k8uf3GLHuhDMgEHg==
|
|
10375
10375
|
|
|
10376
10376
|
typescript@^4.9.5:
|
|
10377
10377
|
version "4.9.5"
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-release-management",
|
|
3
3
|
"description": "A plugin for preparing and publishing npm packages",
|
|
4
|
-
"version": "4.7.
|
|
4
|
+
"version": "4.7.30",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"type": "module",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"@salesforce/core": "^6.7.1",
|
|
18
18
|
"@salesforce/kit": "^3.0.15",
|
|
19
19
|
"@salesforce/plugin-command-reference": "^3.0.70",
|
|
20
|
-
"@salesforce/plugin-trust": "^3.3.
|
|
20
|
+
"@salesforce/plugin-trust": "^3.3.17",
|
|
21
21
|
"@salesforce/sf-plugins-core": "^7.1.15",
|
|
22
22
|
"@salesforce/ts-types": "^2.0.9",
|
|
23
23
|
"aws-sdk": "^2.1579.0",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"eslint-plugin-sf-plugin": "^1.17.4",
|
|
43
43
|
"oclif": "^4.5.4",
|
|
44
44
|
"ts-node": "^10.9.2",
|
|
45
|
-
"typescript": "^5.4.
|
|
45
|
+
"typescript": "^5.4.3"
|
|
46
46
|
},
|
|
47
47
|
"config": {},
|
|
48
48
|
"engines": {
|