Skip to content

Commit 5a36b12

Browse files
committed
chore(release): 5.1.0 [skip ci]
1 parent a23ce06 commit 5a36b12

File tree

3 files changed

+57
-39
lines changed

3 files changed

+57
-39
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# [5.1.0](https://github.com/salesforcecli/plugin-org/compare/5.0.2...5.1.0) (2024-10-30)
2+
3+
### Features
4+
5+
- add source flags for sbx create ([#1237](https://github.com/salesforcecli/plugin-org/issues/1237)) ([a23ce06](https://github.com/salesforcecli/plugin-org/commit/a23ce063f4a4af71e35753518d274d8d8908901b))
6+
17
## [5.0.2](https://github.com/salesforcecli/plugin-org/compare/5.0.1...5.0.2) (2024-10-27)
28

39
### Bug Fixes

README.md

Lines changed: 50 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -121,23 +121,25 @@ Create a sandbox org.
121121
```
122122
USAGE
123123
$ sf org create sandbox -o <value> [--json] [--flags-dir <value>] [-f <value>] [-s] [-a <value>] [-w <minutes> |
124-
--async] [-i <seconds> | ] [-n <value>] [-c <value> | -l Developer|Developer_Pro|Partial|Full] [--no-prompt]
125-
[--no-track-source]
124+
--async] [-i <seconds> | ] [-n <value>] [--source-sandbox-name <value> | -l Developer|Developer_Pro|Partial|Full |
125+
--source-id <value>] [--no-prompt] [--no-track-source]
126126
127127
FLAGS
128-
-a, --alias=<value> Alias for the sandbox org.
129-
-c, --clone=<value> Name of the sandbox org to clone.
130-
-f, --definition-file=<value> Path to a sandbox definition file.
131-
-i, --poll-interval=<seconds> Number of seconds to wait between retries.
132-
-l, --license-type=<option> Type of sandbox license.
133-
<options: Developer|Developer_Pro|Partial|Full>
134-
-n, --name=<value> Name of the sandbox org.
135-
-o, --target-org=<value> (required) Username or alias of the production org that contains the sandbox license.
136-
-s, --set-default Set the sandbox org as your default org.
137-
-w, --wait=<minutes> Number of minutes to wait for the sandbox org to be ready.
138-
--async Request the sandbox creation, but don't wait for it to complete.
139-
--no-prompt Don't prompt for confirmation about the sandbox configuration.
140-
--no-track-source Do not use source tracking for this sandbox.
128+
-a, --alias=<value> Alias for the sandbox org.
129+
-f, --definition-file=<value> Path to a sandbox definition file.
130+
-i, --poll-interval=<seconds> Number of seconds to wait between retries.
131+
-l, --license-type=<option> Type of sandbox license.
132+
<options: Developer|Developer_Pro|Partial|Full>
133+
-n, --name=<value> Name of the sandbox org.
134+
-o, --target-org=<value> (required) Username or alias of the production org that contains the sandbox
135+
license.
136+
-s, --set-default Set the sandbox org as your default org.
137+
-w, --wait=<minutes> Number of minutes to wait for the sandbox org to be ready.
138+
--async Request the sandbox creation, but don't wait for it to complete.
139+
--no-prompt Don't prompt for confirmation about the sandbox configuration.
140+
--no-track-source Do not use source tracking for this sandbox.
141+
--source-id=<value> ID of the sandbox org to clone.
142+
--source-sandbox-name=<value> Name of the sandbox org to clone.
141143
142144
GLOBAL FLAGS
143145
--flags-dir=<value> Import flag values from a directory.
@@ -150,8 +152,8 @@ DESCRIPTION
150152
--name and --license-type flags to specify the two required options. If you want to set an option other than name or
151153
license type, such as apexClassId, you must use a definition file.
152154
153-
You can also use this command to clone an existing sandbox. Use the --clone flag to specify the existing sandbox name
154-
and the --name flag to the name of the new sandbox.
155+
You can also use this command to clone an existing sandbox. Use the --source-sandbox-name flag to specify the existing
156+
sandbox name and the --name flag to the name of the new sandbox.
155157
156158
ALIASES
157159
$ sf env create sandbox
@@ -171,8 +173,8 @@ EXAMPLES
171173
Clone the existing sandbox with name "ExistingSandbox" and name the new sandbox "NewClonedSandbox". Set the new
172174
sandbox as your default org. Wait for 30 minutes for the sandbox creation to complete.
173175
174-
$ sf org create sandbox --clone ExistingSandbox --name NewClonedSandbox --target-org prodOrg --alias \
175-
MyDevSandbox --set-default --wait 30
176+
$ sf org create sandbox --source-sandbox-name ExistingSandbox --name NewClonedSandbox --target-org prodOrg \
177+
--alias MyDevSandbox --set-default --wait 30
176178
177179
FLAG DESCRIPTIONS
178180
-a, --alias=<value> Alias for the sandbox org.
@@ -183,11 +185,6 @@ FLAG DESCRIPTIONS
183185
"mysandbox". When you set an alias for a sandbox org, it's assigned to the resulting username of the user running
184186
this command.
185187
186-
-c, --clone=<value> Name of the sandbox org to clone.
187-
188-
The value of --clone must be an existing sandbox. The existing sandbox, and the new sandbox specified with the
189-
--name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.
190-
191188
-f, --definition-file=<value> Path to a sandbox definition file.
192189
193190
The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each
@@ -227,9 +224,24 @@ FLAG DESCRIPTIONS
227224
CI/CD jobs, you probably don't want to incur the costs of source tracking (checking for conflicts, polling the
228225
SourceMember object, various file system operations.) This is a good use case for disabling source tracking in the
229226
sandbox.
227+
228+
--source-id=<value> ID of the sandbox org to clone.
229+
230+
The value of --source-id must be an existing sandbox. The existing sandbox, and the new sandbox specified with the
231+
--name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.
232+
233+
You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
234+
235+
--source-sandbox-name=<value> Name of the sandbox org to clone.
236+
237+
The value of --source-sandbox-name must be an existing sandbox. The existing sandbox, and the new sandbox specified
238+
with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox
239+
licenses.
240+
241+
You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
230242
```
231243

232-
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/create/sandbox.ts)_
244+
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/create/sandbox.ts)_
233245

234246
## `sf org create scratch`
235247

@@ -383,7 +395,7 @@ FLAG DESCRIPTIONS
383395
Omit this flag to have Salesforce generate a unique username for your org.
384396
```
385397

386-
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/create/scratch.ts)_
398+
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/create/scratch.ts)_
387399

388400
## `sf org delete sandbox`
389401

@@ -429,7 +441,7 @@ EXAMPLES
429441
$ sf org delete sandbox --target-org my-sandbox --no-prompt
430442
```
431443

432-
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/delete/sandbox.ts)_
444+
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/delete/sandbox.ts)_
433445

434446
## `sf org delete scratch`
435447

@@ -473,7 +485,7 @@ EXAMPLES
473485
$ sf org delete scratch --target-org my-scratch-org --no-prompt
474486
```
475487

476-
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/delete/scratch.ts)_
488+
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/delete/scratch.ts)_
477489

478490
## `sf org disable tracking`
479491

@@ -512,7 +524,7 @@ EXAMPLES
512524
$ sf org disable tracking
513525
```
514526

515-
_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/disable/tracking.ts)_
527+
_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/disable/tracking.ts)_
516528

517529
## `sf org display`
518530

@@ -557,7 +569,7 @@ EXAMPLES
557569
$ sf org display --target-org TestOrg1 --verbose
558570
```
559571

560-
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/display.ts)_
572+
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/display.ts)_
561573

562574
## `sf org enable tracking`
563575

@@ -599,7 +611,7 @@ EXAMPLES
599611
$ sf org enable tracking
600612
```
601613

602-
_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/enable/tracking.ts)_
614+
_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/enable/tracking.ts)_
603615

604616
## `sf org list`
605617

@@ -638,7 +650,7 @@ EXAMPLES
638650
$ sf org list --clean
639651
```
640652

641-
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/list.ts)_
653+
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/list.ts)_
642654

643655
## `sf org list metadata`
644656

@@ -705,7 +717,7 @@ FLAG DESCRIPTIONS
705717
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
706718
```
707719

708-
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/list/metadata.ts)_
720+
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/list/metadata.ts)_
709721

710722
## `sf org list metadata-types`
711723

@@ -760,7 +772,7 @@ FLAG DESCRIPTIONS
760772
Override the api version used for api requests made by this command
761773
```
762774

763-
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/list/metadata-types.ts)_
775+
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/list/metadata-types.ts)_
764776

765777
## `sf org open`
766778

@@ -836,7 +848,7 @@ EXAMPLES
836848
$ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
837849
```
838850

839-
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/open.ts)_
851+
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/open.ts)_
840852

841853
## `sf org refresh sandbox`
842854

@@ -913,7 +925,7 @@ FLAG DESCRIPTIONS
913925
By default, a sandbox auto-activates after a refresh. Use this flag to control sandbox activation manually.
914926
```
915927

916-
_See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/refresh/sandbox.ts)_
928+
_See code: [src/commands/org/refresh/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/refresh/sandbox.ts)_
917929

918930
## `sf org resume sandbox`
919931

@@ -976,7 +988,7 @@ FLAG DESCRIPTIONS
976988
returns the job ID. To resume checking the sandbox creation, rerun this command.
977989
```
978990

979-
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/resume/sandbox.ts)_
991+
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/resume/sandbox.ts)_
980992

981993
## `sf org resume scratch`
982994

@@ -1023,6 +1035,6 @@ FLAG DESCRIPTIONS
10231035
The job ID is valid for 24 hours after you start the scratch org creation.
10241036
```
10251037

1026-
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.0.2/src/commands/org/resume/scratch.ts)_
1038+
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/5.1.0/src/commands/org/resume/scratch.ts)_
10271039

10281040
<!-- commandsstop -->

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@salesforce/plugin-org",
33
"description": "Commands to interact with Salesforce orgs",
4-
"version": "5.0.2",
4+
"version": "5.1.0",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)