Skip to content

Commit 6a2226e

Browse files
maggibenmaggiben
committed
chore: merge main
2 parents 9d1b35d + 0e970e7 commit 6a2226e

File tree

19 files changed

+1059
-219
lines changed

19 files changed

+1059
-219
lines changed

‎.circleci/config.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,5 @@ workflows:
130130
only:
131131
- main
132132
jobs:
133-
- release-management/dependabot-automerge
133+
- release-management/dependabot-automerge:
134+
context: release

‎CHANGELOG.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,34 @@
22

33
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
44

5+
## [1.13.0](https://github.com/salesforcecli/plugin-org/compare/v1.12.1...v1.13.0) (2022-05-10)
6+
7+
### Features
8+
9+
- clone command ([481b19d](https://github.com/salesforcecli/plugin-org/commit/481b19d3869ed426bc483a256f486bb0823225ac))
10+
- clone command ([48b2b85](https://github.com/salesforcecli/plugin-org/commit/48b2b85b9bc21856fe35d81b5b2bc595744aa63c))
11+
12+
### Bug Fixes
13+
14+
- bump core ([78186ed](https://github.com/salesforcecli/plugin-org/commit/78186ed0e2f525aab5fa3d741ad67d4e5c4f7f8c))
15+
- test and snapshot updates ([6b469ea](https://github.com/salesforcecli/plugin-org/commit/6b469ea8301377ec4acad8fcbc98e9a6bb4ba5e0))
16+
17+
### [1.12.1](https://github.com/salesforcecli/plugin-org/compare/v1.12.0...v1.12.1) (2022-04-29)
18+
19+
### Bug Fixes
20+
21+
- docs for clean flag ([be868ab](https://github.com/salesforcecli/plugin-org/commit/be868ab5ea13099ba2b3f6a90581609eb0c55164))
22+
23+
## [1.12.0](https://github.com/salesforcecli/plugin-org/compare/v1.11.2...v1.12.0) (2022-04-22)
24+
25+
### Features
26+
27+
- new command org:status ([9524fb6](https://github.com/salesforcecli/plugin-org/commit/9524fb67285cf608d4f7a4dd9c11b2475f643866))
28+
29+
### Bug Fixes
30+
31+
- for set alias ([99c77f0](https://github.com/salesforcecli/plugin-org/commit/99c77f0be12df5c03ee8b1f11e7c9425910ec1b1))
32+
533
### [1.11.2](https://github.com/salesforcecli/plugin-org/compare/v1.11.1...v1.11.2) (2022-02-21)
634

735
### Bug Fixes

‎README.md‎

Lines changed: 103 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,12 @@ sfdx plugins
7979
<!-- commands -->
8080

8181
- [`sfdx force:org:beta:create [name=value...] [-t scratch|sandbox] [-f <filepath>] [-n] [-c] [-i <string>] [-s] [-a <string>] [-w <minutes>] [-d <integer>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceorgbetacreate-namevalue--t-scratchsandbox--f-filepath--n--c--i-string--s--a-string--w-minutes--d-integer--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
82+
- [`sfdx force:org:clone [name=value...] -t sandbox [-f <filepath>] [-s] [-a <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceorgclone-namevalue--t-sandbox--f-filepath--s--a-string--w-minutes--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
8283
- [`sfdx force:org:delete [-p] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceorgdelete--p--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
8384
- [`sfdx force:org:display [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceorgdisplay--u-string---apiversion-string---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
8485
- [`sfdx force:org:list [--all] [-p --clean] [--skipconnectionstatus] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceorglist---all--p---clean---skipconnectionstatus---verbose---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
8586
- [`sfdx force:org:open [-b <string> | -r] [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceorgopen--b-string---r--p-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
87+
- [`sfdx force:org:status -n <string> [-s] [-a <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceorgstatus--n-string--s--a-string--w-minutes--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
8688

8789
## `sfdx force:org:beta:create [name=value...] [-t scratch|sandbox] [-f <filepath>] [-n] [-c] [-i <string>] [-s] [-a <string>] [-w <minutes>] [-d <integer>] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
8890

@@ -149,7 +151,52 @@ EXAMPLES
149151
$ sfdx force:org:create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
150152
```
151153

152-
_See code: [src/commands/force/org/beta/create.ts](https://github.com/salesforcecli/plugin-org/blob/v1.11.1/src/commands/force/org/beta/create.ts)_
154+
_See code: [src/commands/force/org/beta/create.ts](https://github.com/salesforcecli/plugin-org/blob/v1.12.1/src/commands/force/org/beta/create.ts)_
155+
156+
## `sfdx force:org:clone [name=value...] -t sandbox [-f <filepath>] [-s] [-a <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
157+
158+
clone a sandbox org
159+
160+
```
161+
USAGE
162+
$ sfdx force:org:clone [name=value...] -t sandbox [-f <filepath>] [-s] [-a <string>] [-w <minutes>] [-u <string>]
163+
[--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
164+
165+
OPTIONS
166+
-a, --setalias=setalias alias for the cloned org
167+
-f, --definitionfile=definitionfile path to the sandbox definition file
168+
-s, --setdefaultusername set the cloned org as your default
169+
-t, --type=(sandbox) (required) type of org to create
170+
171+
-u, --targetusername=targetusername username or alias for the target
172+
org; overrides default target org
173+
174+
-w, --wait=wait [default: 6 minutes] number of
175+
minutes to wait while polling for
176+
status
177+
178+
--apiversion=apiversion override the api version used for
179+
api requests made by this command
180+
181+
--json format output as json
182+
183+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
184+
this command invocation
185+
186+
DESCRIPTION
187+
There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the
188+
command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either
189+
case, you must specify both the "SandboxName" and "SourceSandboxName" options.
190+
191+
Set the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is
192+
required and must be set to "sandbox".
193+
194+
EXAMPLES
195+
$ sfdx force:org:clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox
196+
$ sfdx force:org:clone -t sandbox SandboxName=DevSbx1 SourceSandboxName=Sbx2Clone -u prodOrg -a MyDevSandbox
197+
```
198+
199+
_See code: [src/commands/force/org/clone.ts](https://github.com/salesforcecli/plugin-org/blob/v1.12.1/src/commands/force/org/clone.ts)_
153200

154201
## `sfdx force:org:delete [-p] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
155202

@@ -185,7 +232,7 @@ EXAMPLES
185232
$ sfdx force:org:delete -u MyOrgAlias -p
186233
```
187234

188-
_See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/v1.11.1/src/commands/force/org/delete.ts)_
235+
_See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/v1.12.1/src/commands/force/org/delete.ts)_
189236

190237
## `sfdx force:org:display [-u <string>] [--apiversion <string>] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
191238

@@ -226,7 +273,7 @@ EXAMPLES
226273
sfdx force:org:display -u TestOrg1 --json > tmp/MyOrgDesc.json
227274
```
228275

229-
_See code: [src/commands/force/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/v1.11.1/src/commands/force/org/display.ts)_
276+
_See code: [src/commands/force/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/v1.12.1/src/commands/force/org/display.ts)_
230277

231278
## `sfdx force:org:list [--all] [-p --clean] [--skipconnectionstatus] [--verbose] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
232279

@@ -244,7 +291,9 @@ OPTIONS
244291
unknown-status scratch orgs
245292
246293
--clean remove all local org authorizations
247-
for non-active orgs
294+
for non-active scratch orgs. Use
295+
auth:logout to remove non-scratch
296+
orgs
248297
249298
--json format output as json
250299
@@ -262,7 +311,7 @@ EXAMPLES
262311
sfdx force:org:list --verbose --json > tmp/MyOrgList.json
263312
```
264313

265-
_See code: [src/commands/force/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/v1.11.1/src/commands/force/org/list.ts)_
314+
_See code: [src/commands/force/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/v1.12.1/src/commands/force/org/list.ts)_
266315

267316
## `sfdx force:org:open [-b <string> | -r] [-p <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
268317

@@ -307,6 +356,54 @@ EXAMPLES
307356
sfdx force:org:open -u [email protected] -b firefox
308357
```
309358

310-
_See code: [src/commands/force/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/v1.11.1/src/commands/force/org/open.ts)_
359+
_See code: [src/commands/force/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/v1.12.1/src/commands/force/org/open.ts)_
360+
361+
## `sfdx force:org:status -n <string> [-s] [-a <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
362+
363+
report status of sandbox creation or clone and authenticate to it
364+
365+
```
366+
USAGE
367+
$ sfdx force:org:status -n <string> [-s] [-a <string>] [-w <minutes>] [-u <string>] [--apiversion <string>] [--json]
368+
[--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
369+
370+
OPTIONS
371+
-a, --setalias=setalias alias for the created or cloned org
372+
373+
-n, --sandboxname=sandboxname (required) name of the sandbox org
374+
to check status for
375+
376+
-s, --setdefaultusername set the created or cloned org as
377+
your default
378+
379+
-u, --targetusername=targetusername username or alias for the target
380+
org; overrides default target org
381+
382+
-w, --wait=wait [default: 6 minutes] number of
383+
minutes to wait while polling for
384+
status
385+
386+
--apiversion=apiversion override the api version used for
387+
api requests made by this command
388+
389+
--json format output as json
390+
391+
--loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for
392+
this command invocation
393+
394+
DESCRIPTION
395+
Use this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to
396+
it.
397+
Use the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or
398+
clone to complete before returning control of the terminal to you.
399+
Set the --targetusername (-u) parameter to the username or alias of the production org that contains the sandbox
400+
license.
401+
402+
EXAMPLES
403+
sfdx force:org:status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg
404+
sfdx force:org:status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
405+
```
406+
407+
_See code: [src/commands/force/org/status.ts](https://github.com/salesforcecli/plugin-org/blob/v1.12.1/src/commands/force/org/status.ts)_
311408

312409
<!-- commandsstop -->

‎command-snapshot.json‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,34 @@
3939
"command": "force:org:open",
4040
"plugin": "@salesforce/plugin-org",
4141
"flags": ["apiversion", "browser", "json", "loglevel", "path", "targetusername", "urlonly"]
42+
},
43+
{
44+
"command": "force:org:status",
45+
"plugin": "@salesforce/plugin-org",
46+
"flags": [
47+
"apiversion",
48+
"json",
49+
"loglevel",
50+
"sandboxname",
51+
"setalias",
52+
"setdefaultusername",
53+
"targetusername",
54+
"wait"
55+
]
56+
},
57+
{
58+
"command": "force:org:clone",
59+
"plugin": "@salesforce/plugin-org",
60+
"flags": [
61+
"apiversion",
62+
"json",
63+
"loglevel",
64+
"type",
65+
"definitionfile",
66+
"setalias",
67+
"setdefaultusername",
68+
"targetusername",
69+
"wait"
70+
]
4271
}
4372
]

‎messages/clone.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"success": "The sandbox org cloning process %s is in progress. Run \"sfdx force:org:status -n %s\" to check for status. If the org is ready, checking the status also logs the requesting user in to the sandbox org and authorizes the org for use with Salesforce CLI.",
3+
"description": "clone a sandbox org\nThere are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either case, you must specify both the \"SandboxName\" and \"SourceSandboxName\" options. \n\nSet the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is required and must be set to \"sandbox\".",
4+
"examples": [
5+
"$ sfdx force:org:clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox",
6+
"$ sfdx force:org:clone -t sandbox SandboxName=DevSbx1 SourceSandboxName=Sbx2Clone -u prodOrg -a MyDevSandbox"
7+
],
8+
"flags": {
9+
"type": "type of org to create",
10+
"wait": "number of minutes to wait while polling for status",
11+
"setdefaultusername": "set the cloned org as your default",
12+
"setalias": "alias for the cloned org",
13+
"definitionfile": "path to the sandbox definition file"
14+
},
15+
"commandSuccess": "The sandbox org cloning process %s is in progress. Run \"sfdx force:org:status -n %s\" to check for status. If the org is ready, checking the status also logs the requesting user in to the sandbox org and authorizes the org for use with Salesforce CLI.",
16+
"missingLicenseType": "The sandbox license type is required, but you didn't provide a value. Specify the license type in the sandbox definition file with the \"licenseType\" option, or specify the option as a name-value pair at the command-line. See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm for more information.",
17+
"commandOrganizationTypeNotSupport": "The only supported org type is: %s",
18+
"commandOrganizationTypeNotSupportAction": "force:org:clone -t %s",
19+
"missingSourceSandboxName": "Specify a value for %s in a definition file or on the command line.",
20+
"missingSourceSandboxNameAction": "To indicate which sandbox org you want to clone, specify %s in a definition file or as a command line argument."
21+
}

‎messages/list.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
],
88
"verbose": "list more information about each org",
99
"all": "include expired, deleted, and unknown-status scratch orgs",
10-
"clean": "remove all local org authorizations for non-active orgs",
10+
"clean": "remove all local org authorizations for non-active scratch orgs. Use auth:logout to remove non-scratch orgs",
1111
"noPrompt": "do not prompt for confirmation",
1212
"skipConnectionStatus": "skip retrieving the connection status of non-scratch orgs",
1313
"prompt": "Found (%s) org configurations to delete. Are you sure (yes/no)?",

‎messages/status.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"examples": [
3+
"sfdx force:org:status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg",
4+
"sfdx force:org:status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg"
5+
],
6+
"description": "report status of sandbox creation or clone and authenticate to it\nUse this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to it.\nUse the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or clone to complete before returning control of the terminal to you.\nSet the --targetusername (-u) parameter to the username or alias of the production org that contains the sandbox license.",
7+
"flags": {
8+
"sandboxname": "name of the sandbox org to check status for",
9+
"wait": "number of minutes to wait while polling for status",
10+
"setdefaultusername": "set the created or cloned org as your default",
11+
"setalias": "alias for the created or cloned org"
12+
}
13+
}

‎package.json‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
22
"name": "@salesforce/plugin-org",
33
"description": "A template repository for sfdx plugins",
4-
"version": "1.11.2",
4+
"version": "1.13.0",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {
88
"@oclif/config": "^1.18.1",
99
"@salesforce/command": "^4.2.2",
10-
"@salesforce/core": "^2.35.0",
10+
"@salesforce/core": "^2.36.3",
1111
"@salesforce/kit": "^1.5.17",
1212
"open": "8.4.0",
1313
"tslib": "^2"
@@ -33,7 +33,7 @@
3333
"eslint-config-salesforce-license": "^0.1.6",
3434
"eslint-config-salesforce-typescript": "^0.2.8",
3535
"eslint-plugin-header": "^3.0.0",
36-
"eslint-plugin-import": "2.25.4",
36+
"eslint-plugin-import": "2.26.0",
3737
"eslint-plugin-jsdoc": "^35.1.2",
3838
"eslint-plugin-prettier": "^3.1.3",
3939
"husky": "^7.0.4",
@@ -49,13 +49,16 @@
4949
"ts-node": "^10.0.0",
5050
"typescript": "^4.4.4"
5151
},
52+
"resolutions": {
53+
"@salesforce/core": "^2.37.1"
54+
},
5255
"config": {
5356
"commitizen": {
5457
"path": "cz-conventional-changelog"
5558
}
5659
},
5760
"engines": {
58-
"node": ">=12.0.0"
61+
"node": ">=14.0.0"
5962
},
6063
"files": [
6164
"/lib",

0 commit comments

Comments
 (0)