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