Skip to content

Commit bfe9e99

Browse files
committed
chore(release): 3.2.0 [skip ci]
1 parent b92a8b6 commit bfe9e99

File tree

3 files changed

+20
-186
lines changed

3 files changed

+20
-186
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# [3.2.0](https://github.com/salesforcecli/plugin-org/compare/3.1.8...3.2.0) (2024-01-02)
2+
3+
### Features
4+
5+
- hide deprecated commands ([c231c98](https://github.com/salesforcecli/plugin-org/commit/c231c985f838339948a8348e7d05062007ccc2ad))
6+
17
## [3.1.8](https://github.com/salesforcecli/plugin-org/compare/3.1.7...3.1.8) (2024-01-02)
28

39
### Bug Fixes

README.md

Lines changed: 13 additions & 185 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,6 @@ the [SandboxNuts](https://github.com/salesforcecli/plugin-org/actions/workflows/
9999

100100
<!-- commands -->
101101

102-
- [`sf force org clone`](#sf-force-org-clone)
103-
- [`sf force org create`](#sf-force-org-create)
104-
- [`sf force org delete`](#sf-force-org-delete)
105-
- [`sf force org status`](#sf-force-org-status)
106102
- [`sf org create sandbox`](#sf-org-create-sandbox)
107103
- [`sf org create scratch`](#sf-org-create-scratch)
108104
- [`sf org delete sandbox`](#sf-org-delete-sandbox)
@@ -117,174 +113,6 @@ the [SandboxNuts](https://github.com/salesforcecli/plugin-org/actions/workflows/
117113
- [`sf org resume sandbox`](#sf-org-resume-sandbox)
118114
- [`sf org resume scratch`](#sf-org-resume-scratch)
119115

120-
## `sf force org clone`
121-
122-
Clone a sandbox org.
123-
124-
```
125-
USAGE
126-
$ sf force org clone -o <value> -t sandbox [--json] [--api-version <value>] [-f <value>] [-s] [-a <value>] [-w
127-
<value>]
128-
129-
FLAGS
130-
-a, --setalias=<value> Alias for the cloned org.
131-
-f, --definitionfile=<value> Path to the sandbox definition file.
132-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
133-
configuration variable is already set.
134-
-s, --setdefaultusername Set the cloned org as your default.
135-
-t, --type=<option> (required) Type of org to create.
136-
<options: sandbox>
137-
-w, --wait=<value> [default: 6 minutes] Number of minutes to wait while polling for status.
138-
--api-version=<value> Override the api version used for api requests made by this command
139-
140-
GLOBAL FLAGS
141-
--json Format output as json.
142-
143-
DESCRIPTION
144-
Clone a sandbox org.
145-
146-
There are two ways to clone a sandbox: either specify a sandbox definition file or provide key=value pairs at the
147-
command line. Key-value pairs at the command-line override their equivalent sandbox definition file values. In either
148-
case, you must specify both the "SandboxName" and "SourceSandboxName" options to set the names of the new sandbox and
149-
the one being cloned, respectively.
150-
151-
Set the --targetusername (-u) parameter to a production org with sandbox licenses. The --type (-t) parameter is
152-
required and must be set to "sandbox".
153-
154-
EXAMPLES
155-
$ sf force org clone -t sandbox -f config/dev-sandbox-def.json -u prodOrg -a MyDevSandbox
156-
157-
$ sf force org clone -t sandbox SandboxName=NewClonedSandbox SourceSandboxName=ExistingSandbox -u prodOrg -a MyDevSandbox
158-
159-
FLAG DESCRIPTIONS
160-
-w, --wait=<value> Number of minutes to wait while polling for status.
161-
162-
Sets the streaming client socket timeout, in minutes. If the streaming client socket has no contact from the server
163-
for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
164-
```
165-
166-
_See code: [src/commands/force/org/clone.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/force/org/clone.ts)_
167-
168-
## `sf force org create`
169-
170-
Create a scratch org or sandbox.
171-
172-
```
173-
USAGE
174-
$ sf force org create [--json] [-o <value>] [-v <value>] [--api-version <value>] [-t scratch|sandbox] [-f <value>]
175-
[-n] [-c] [-i <value>] [-s] [-a <value>] [-w <value>] [-d <value>]
176-
177-
FLAGS
178-
-a, --setalias=<value> Alias for the created org.
179-
-c, --noancestors Do not include second-generation package ancestors in the scratch org.
180-
-d, --durationdays=<value> [default: 7] Duration of the scratch org (in days) (default:7, min:1, max:30).
181-
-f, --definitionfile=<value> Path to an org definition file.
182-
-i, --clientid=<value> Connected app consumer key; not supported for sandbox org creation.
183-
-n, --nonamespace Create the scratch org with no namespace.
184-
-o, --target-org=<value> Username or alias of the production org that contains the sandbox license.
185-
-s, --setdefaultusername Set the created org as the default username.
186-
-t, --type=<option> [default: scratch] Type of org to create.
187-
<options: scratch|sandbox>
188-
-v, --target-dev-hub=<value> Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration
189-
variable is already set.
190-
-w, --wait=<value> [default: 6 minutes] Streaming client socket timeout (in minutes).
191-
--api-version=<value> Override the api version used for api requests made by this command
192-
193-
GLOBAL FLAGS
194-
--json Format output as json.
195-
196-
DESCRIPTION
197-
Create a scratch org or sandbox.
198-
199-
Creates a scratch org or a sandbox org using the values specified in a configuration file or key=value pairs that you
200-
specify on the command line. Values specified on the command line override values in the configuration file. Specify a
201-
configuration file or provide key=value pairs while creating a scratch org or a sandbox. When creating scratch orgs,
202-
—targetdevhubusername (-v) must be a Dev Hub org. When creating sandboxes, the --targetusername (-u) must be a
203-
production org with sandbox licenses. The —type (-t) is required if creating a sandbox.
204-
205-
EXAMPLES
206-
$ sf force org create -f config/enterprise-scratch-def.json -a MyScratchOrg
207-
208-
$ sf force org create edition=Developer -a MyScratchOrg -s -v devHub
209-
210-
$ sf force org create -f config/enterprise-scratch-def.json -a ScratchOrgWithOverrides [email protected]
211-
212-
$ sf force org create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
213-
```
214-
215-
_See code: [src/commands/force/org/create.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/force/org/create.ts)_
216-
217-
## `sf force org delete`
218-
219-
Delete a scratch or sandbox org.
220-
221-
```
222-
USAGE
223-
$ sf force org delete -o <value> [--json] [--api-version <value>] [-p]
224-
225-
FLAGS
226-
-o, --target-org=<value> (required) Username or alias of the target org.
227-
-p, --no-prompt No prompt to confirm deletion.
228-
--api-version=<value> Override the api version used for api requests made by this command
229-
230-
GLOBAL FLAGS
231-
--json Format output as json.
232-
233-
DESCRIPTION
234-
Delete a scratch or sandbox org.
235-
236-
Salesforce CLI marks the org for deletion in either the Dev Hub org (for scratch orgs) or production org (for
237-
sandboxes) and then deletes all local references to the org from your computer.
238-
239-
To mark the org for deletion without being prompted to confirm, specify --noprompt.
240-
241-
EXAMPLES
242-
$ sf force org delete -u [email protected]
243-
244-
$ sf force org delete -u MyOrgAlias -p
245-
```
246-
247-
_See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/force/org/delete.ts)_
248-
249-
## `sf force org status`
250-
251-
Check the status of a sandbox, and if complete, authenticate to it.
252-
253-
```
254-
USAGE
255-
$ sf force org status -o <value> -n <value> [--json] [--api-version <value>] [-s] [-a <value>] [-w <value>]
256-
257-
FLAGS
258-
-a, --setalias=<value> Alias for the created or cloned org.
259-
-n, --sandboxname=<value> (required) Name of the sandbox org to check status for.
260-
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
261-
configuration variable is already set.
262-
-s, --setdefaultusername Set the created or cloned org as your default.
263-
-w, --wait=<value> [default: 6 minutes] Number of minutes to wait while polling for status.
264-
--api-version=<value> Override the api version used for api requests made by this command
265-
266-
GLOBAL FLAGS
267-
--json Format output as json.
268-
269-
DESCRIPTION
270-
Check the status of a sandbox, and if complete, authenticate to it.
271-
272-
Use this command to check the status of your sandbox creation or clone and, if the sandbox is ready, authenticate to
273-
it.
274-
275-
Use the --wait (-w) parameter to specify the number of minutes that the command waits for the sandbox creation or
276-
clone to complete before returning control of the terminal to you.
277-
278-
Set the --target-org (-o) parameter to the username or alias of the production org that contains the sandbox license.
279-
280-
EXAMPLES
281-
$ sf force org status --sandboxname DevSbx1 --setalias MySandbox -u prodOrg
282-
283-
$ sf force org status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
284-
```
285-
286-
_See code: [src/commands/force/org/status.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/force/org/status.ts)_
287-
288116
## `sf org create sandbox`
289117

290118
Create a sandbox org.
@@ -388,7 +216,7 @@ FLAG DESCRIPTIONS
388216
sandbox.
389217
```
390218

391-
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/create/sandbox.ts)_
219+
_See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/create/sandbox.ts)_
392220

393221
## `sf org create scratch`
394222

@@ -541,7 +369,7 @@ FLAG DESCRIPTIONS
541369
Omit this flag to have Salesforce generate a unique username for your org.
542370
```
543371

544-
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/create/scratch.ts)_
372+
_See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/create/scratch.ts)_
545373

546374
## `sf org delete sandbox`
547375

@@ -585,7 +413,7 @@ EXAMPLES
585413
$ sf org delete sandbox --target-org my-sandbox --no-prompt
586414
```
587415

588-
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/delete/sandbox.ts)_
416+
_See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/delete/sandbox.ts)_
589417

590418
## `sf org delete scratch`
591419

@@ -627,7 +455,7 @@ EXAMPLES
627455
$ sf org delete scratch --target-org my-scratch-org --no-prompt
628456
```
629457

630-
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/delete/scratch.ts)_
458+
_See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/delete/scratch.ts)_
631459

632460
## `sf org disable tracking`
633461

@@ -665,7 +493,7 @@ EXAMPLES
665493
$ sf org disable tracking
666494
```
667495

668-
_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/disable/tracking.ts)_
496+
_See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/disable/tracking.ts)_
669497

670498
## `sf org display`
671499

@@ -709,7 +537,7 @@ EXAMPLES
709537
$ sf org display --target-org TestOrg1 --verbose
710538
```
711539

712-
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/display.ts)_
540+
_See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/display.ts)_
713541

714542
## `sf org enable tracking`
715543

@@ -750,7 +578,7 @@ EXAMPLES
750578
$ sf org enable tracking
751579
```
752580

753-
_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/enable/tracking.ts)_
581+
_See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/enable/tracking.ts)_
754582

755583
## `sf org list`
756584

@@ -788,7 +616,7 @@ EXAMPLES
788616
$ sf org list --clean
789617
```
790618

791-
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/list.ts)_
619+
_See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/list.ts)_
792620

793621
## `sf org list metadata`
794622

@@ -853,7 +681,7 @@ FLAG DESCRIPTIONS
853681
Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
854682
```
855683

856-
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/list/metadata.ts)_
684+
_See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/list/metadata.ts)_
857685

858686
## `sf org list metadata-types`
859687

@@ -907,7 +735,7 @@ FLAG DESCRIPTIONS
907735
Override the api version used for api requests made by this command
908736
```
909737

910-
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/list/metadata-types.ts)_
738+
_See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/list/metadata-types.ts)_
911739

912740
## `sf org open`
913741

@@ -973,7 +801,7 @@ EXAMPLES
973801
$ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
974802
```
975803

976-
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/open.ts)_
804+
_See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/open.ts)_
977805

978806
## `sf org resume sandbox`
979807

@@ -1035,7 +863,7 @@ FLAG DESCRIPTIONS
1035863
returns the job ID. To resume checking the sandbox creation, rerun this command.
1036864
```
1037865

1038-
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/resume/sandbox.ts)_
866+
_See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/resume/sandbox.ts)_
1039867

1040868
## `sf org resume scratch`
1041869

@@ -1081,6 +909,6 @@ FLAG DESCRIPTIONS
1081909
The job ID is valid for 24 hours after you start the scratch org creation.
1082910
```
1083911

1084-
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.1.8/src/commands/org/resume/scratch.ts)_
912+
_See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.2.0/src/commands/org/resume/scratch.ts)_
1085913

1086914
<!-- 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": "3.1.8",
4+
"version": "3.2.0",
55
"author": "Salesforce",
66
"bugs": "https://github.com/forcedotcom/cli/issues",
77
"dependencies": {

0 commit comments

Comments
 (0)