@salesforce/plugin-org 3.0.6 → 3.0.7

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 CHANGED
@@ -162,7 +162,7 @@ FLAG DESCRIPTIONS
162
162
  for a number of minutes, the client exits. Specify a longer wait time if timeouts occur frequently.
163
163
  ```
164
164
 
165
- _See code: [src/commands/force/org/clone.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/force/org/clone.ts)_
165
+ _See code: [src/commands/force/org/clone.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/force/org/clone.ts)_
166
166
 
167
167
  ## `sf force org create`
168
168
 
@@ -210,7 +210,7 @@ EXAMPLES
210
210
  $ sf force org create -t sandbox -f config/dev-sandbox-def.json -a MyDevSandbox -u prodOrg
211
211
  ```
212
212
 
213
- _See code: [src/commands/force/org/create.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/force/org/create.ts)_
213
+ _See code: [src/commands/force/org/create.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/force/org/create.ts)_
214
214
 
215
215
  ## `sf force org delete`
216
216
 
@@ -242,7 +242,7 @@ EXAMPLES
242
242
  $ sf force org delete -u MyOrgAlias -p
243
243
  ```
244
244
 
245
- _See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/force/org/delete.ts)_
245
+ _See code: [src/commands/force/org/delete.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/force/org/delete.ts)_
246
246
 
247
247
  ## `sf force org status`
248
248
 
@@ -280,7 +280,7 @@ EXAMPLES
280
280
  $ sf force org status --sandboxname DevSbx1 --wait 45 --setdefaultusername -u prodOrg
281
281
  ```
282
282
 
283
- _See code: [src/commands/force/org/status.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/force/org/status.ts)_
283
+ _See code: [src/commands/force/org/status.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/force/org/status.ts)_
284
284
 
285
285
  ## `sf org create sandbox`
286
286
 
@@ -385,7 +385,7 @@ FLAG DESCRIPTIONS
385
385
  sandbox.
386
386
  ```
387
387
 
388
- _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/create/sandbox.ts)_
388
+ _See code: [src/commands/org/create/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/create/sandbox.ts)_
389
389
 
390
390
  ## `sf org create scratch`
391
391
 
@@ -538,7 +538,7 @@ FLAG DESCRIPTIONS
538
538
  Omit this flag to have Salesforce generate a unique username for your org.
539
539
  ```
540
540
 
541
- _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/create/scratch.ts)_
541
+ _See code: [src/commands/org/create/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/create/scratch.ts)_
542
542
 
543
543
  ## `sf org delete sandbox`
544
544
 
@@ -582,7 +582,7 @@ EXAMPLES
582
582
  $ sf org delete sandbox --target-org my-sandbox --no-prompt
583
583
  ```
584
584
 
585
- _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/delete/sandbox.ts)_
585
+ _See code: [src/commands/org/delete/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/delete/sandbox.ts)_
586
586
 
587
587
  ## `sf org delete scratch`
588
588
 
@@ -624,11 +624,11 @@ EXAMPLES
624
624
  $ sf org delete scratch --target-org my-scratch-org --no-prompt
625
625
  ```
626
626
 
627
- _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/delete/scratch.ts)_
627
+ _See code: [src/commands/org/delete/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/delete/scratch.ts)_
628
628
 
629
629
  ## `sf org disable tracking`
630
630
 
631
- Disable source tracking in local auth file.
631
+ Prevent Salesforce CLI from tracking changes in your source files between your project and an org.
632
632
 
633
633
  ```
634
634
  USAGE
@@ -641,21 +641,27 @@ GLOBAL FLAGS
641
641
  --json Format output as json.
642
642
 
643
643
  DESCRIPTION
644
- Disable source tracking in local auth file.
644
+ Prevent Salesforce CLI from tracking changes in your source files between your project and an org.
645
645
 
646
- This has no effect on the org. It stores the setting in the CLI's configuration file for this org so that no source
647
- tracking operations are executed when working with this org.
646
+ Disabling source tracking has no direct effect on the org, it affects only your local environment. Specifically,
647
+ Salesforce CLI stores the setting in the org's local configuration file so that no source tracking operations are
648
+ executed when working with the org.
648
649
 
649
650
  EXAMPLES
650
- Disable tracking on an org using an alias
651
- - sf org disable tracking -o someAlias
652
- Disable tracking on an org using a username
653
- - sf org disable tracking -o you@example.com
654
- Disable tracking on your default org
655
- - sf org disable tracking
651
+ Disable source tracking for an org with alias "myscratch":
652
+
653
+ $ sf org disable tracking --target-org myscratch
654
+
655
+ Disable source tracking for an org using a username:
656
+
657
+ $ sf org disable tracking --target-org you@example.com
658
+
659
+ Disable source tracking for your default org:
660
+
661
+ $ sf org disable tracking
656
662
  ```
657
663
 
658
- _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/disable/tracking.ts)_
664
+ _See code: [src/commands/org/disable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/disable/tracking.ts)_
659
665
 
660
666
  ## `sf org display`
661
667
 
@@ -698,11 +704,11 @@ EXAMPLES
698
704
  $ sf org display --target-org TestOrg1 --verbose
699
705
  ```
700
706
 
701
- _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/display.ts)_
707
+ _See code: [src/commands/org/display.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/display.ts)_
702
708
 
703
709
  ## `sf org enable tracking`
704
710
 
705
- Enable source tracking in local auth file.
711
+ Allow Salesforce CLI to track changes in your source files between your project and an org.
706
712
 
707
713
  ```
708
714
  USAGE
@@ -715,23 +721,30 @@ GLOBAL FLAGS
715
721
  --json Format output as json.
716
722
 
717
723
  DESCRIPTION
718
- Enable source tracking in local auth file.
724
+ Allow Salesforce CLI to track changes in your source files between your project and an org.
719
725
 
720
- This has no effect on the org. It stores the setting in the CLI's configuration file for this org so that source
721
- tracking operations are executed when working with this org.
726
+ Enabling source tracking has no direct effect on the org, it affects only your local environment. Specifically,
727
+ Salesforce CLI stores the setting in the org's local configuration file so that source tracking operations are
728
+ executed when working with the org.
722
729
 
723
- This command will throw an error if the org does not support tracking.
730
+ This command throws an error if the org doesn't support tracking. Examples of orgs that don't support source tracking
731
+ include Developer Edition orgs, production orgs, Partial Copy sandboxes, and Full sandboxes.
724
732
 
725
733
  EXAMPLES
726
- Enable tracking on an org using an alias
727
- - sf org enable tracking -o someAlias
728
- Enable tracking on an org using a username
729
- - sf org enable tracking -o you@example.com
730
- Enable tracking on your default org
731
- - sf org enable tracking
734
+ Enable source tracking for an org with alias "myscratch":
735
+
736
+ $ sf org enable tracking --target-org myscratch
737
+
738
+ Enable source tracking for an org using a username:
739
+
740
+ $ sf org enable tracking --target-org you@example.com
741
+
742
+ Enable source tracking for your default org:
743
+
744
+ $ sf org enable tracking
732
745
  ```
733
746
 
734
- _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/enable/tracking.ts)_
747
+ _See code: [src/commands/org/enable/tracking.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/enable/tracking.ts)_
735
748
 
736
749
  ## `sf org list`
737
750
 
@@ -769,7 +782,7 @@ EXAMPLES
769
782
  $ sf org list --clean
770
783
  ```
771
784
 
772
- _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/list.ts)_
785
+ _See code: [src/commands/org/list.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/list.ts)_
773
786
 
774
787
  ## `sf org list metadata`
775
788
 
@@ -833,7 +846,7 @@ FLAG DESCRIPTIONS
833
846
  Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
834
847
  ```
835
848
 
836
- _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/list/metadata.ts)_
849
+ _See code: [src/commands/org/list/metadata.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/list/metadata.ts)_
837
850
 
838
851
  ## `sf org list metadata-types`
839
852
 
@@ -886,7 +899,7 @@ FLAG DESCRIPTIONS
886
899
  Override the api version used for api requests made by this command
887
900
  ```
888
901
 
889
- _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/list/metadata-types.ts)_
902
+ _See code: [src/commands/org/list/metadata-types.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/list/metadata-types.ts)_
890
903
 
891
904
  ## `sf org open`
892
905
 
@@ -951,7 +964,7 @@ EXAMPLES
951
964
  $ sf org open --source-file force-app/main/default/flows/Hello.flow-meta.xml
952
965
  ```
953
966
 
954
- _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/open.ts)_
967
+ _See code: [src/commands/org/open.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/open.ts)_
955
968
 
956
969
  ## `sf org resume sandbox`
957
970
 
@@ -1013,7 +1026,7 @@ FLAG DESCRIPTIONS
1013
1026
  returns the job ID. To resume checking the sandbox creation, rerun this command.
1014
1027
  ```
1015
1028
 
1016
- _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/resume/sandbox.ts)_
1029
+ _See code: [src/commands/org/resume/sandbox.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/resume/sandbox.ts)_
1017
1030
 
1018
1031
  ## `sf org resume scratch`
1019
1032
 
@@ -1059,6 +1072,6 @@ FLAG DESCRIPTIONS
1059
1072
  The job ID is valid for 24 hours after you start the scratch org creation.
1060
1073
  ```
1061
1074
 
1062
- _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.6/src/commands/org/resume/scratch.ts)_
1075
+ _See code: [src/commands/org/resume/scratch.ts](https://github.com/salesforcecli/plugin-org/blob/3.0.7/src/commands/org/resume/scratch.ts)_
1063
1076
 
1064
1077
  <!-- commandsstop -->
@@ -1,24 +1,24 @@
1
1
  # summary
2
2
 
3
- Disable source tracking in local auth file.
3
+ Prevent Salesforce CLI from tracking changes in your source files between your project and an org.
4
4
 
5
5
  # description
6
6
 
7
- This has no effect on the org. It stores the setting in the CLI's configuration file for this org so that no source tracking operations are executed when working with this org.
7
+ Disabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that no source tracking operations are executed when working with the org.
8
8
 
9
9
  # examples
10
10
 
11
- Disable tracking on an org using an alias
11
+ - Disable source tracking for an org with alias "myscratch":
12
12
 
13
- - <%= config.bin %> <%= command.id %> -o someAlias
13
+ <%= config.bin %> <%= command.id %> --target-org myscratch
14
14
 
15
- Disable tracking on an org using a username
15
+ - Disable source tracking for an org using a username:
16
16
 
17
- - <%= config.bin %> <%= command.id %> -o you@example.com
17
+ <%= config.bin %> <%= command.id %> --target-org you@example.com
18
18
 
19
- Disable tracking on your default org
19
+ - Disable source tracking for your default org:
20
20
 
21
- - <%= config.bin %> <%= command.id %>
21
+ <%= config.bin %> <%= command.id %>
22
22
 
23
23
  # success
24
24
 
@@ -1,26 +1,26 @@
1
1
  # summary
2
2
 
3
- Enable source tracking in local auth file.
3
+ Allow Salesforce CLI to track changes in your source files between your project and an org.
4
4
 
5
5
  # description
6
6
 
7
- This has no effect on the org. It stores the setting in the CLI's configuration file for this org so that source tracking operations are executed when working with this org.
7
+ Enabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that source tracking operations are executed when working with the org.
8
8
 
9
- This command will throw an error if the org does not support tracking.
9
+ This command throws an error if the org doesn't support tracking. Examples of orgs that don't support source tracking include Developer Edition orgs, production orgs, Partial Copy sandboxes, and Full sandboxes.
10
10
 
11
11
  # examples
12
12
 
13
- Enable tracking on an org using an alias
13
+ - Enable source tracking for an org with alias "myscratch":
14
14
 
15
- - <%= config.bin %> <%= command.id %> -o someAlias
15
+ <%= config.bin %> <%= command.id %> --target-org myscratch
16
16
 
17
- Enable tracking on an org using a username
17
+ - Enable source tracking for an org using a username:
18
18
 
19
- - <%= config.bin %> <%= command.id %> -o you@example.com
19
+ <%= config.bin %> <%= command.id %> --target-org you@example.com
20
20
 
21
- Enable tracking on your default org
21
+ - Enable source tracking for your default org:
22
22
 
23
- - <%= config.bin %> <%= command.id %>
23
+ <%= config.bin %> <%= command.id %>
24
24
 
25
25
  # success
26
26
 
@@ -28,12 +28,12 @@ Enabled source tracking for %s.
28
28
 
29
29
  # error.TrackingNotAvailable
30
30
 
31
- This org cannot enable source tracking because the SourceMember object is not available, or you do not have access to it.
31
+ You can't enable source tracking on this org because the SourceMember Tooling API object isn't available, or you don't have access to it.
32
32
 
33
33
  # error.TrackingNotAvailable.actions
34
34
 
35
- - If the org is a sandbox, make sure that your production org has Source Tracking enabled in sandboxes. See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_setup_enable_source_tracking_sandboxes.htm.
35
+ - If the org is a Developer or Developer Pro sandbox, make sure that the associated production org has enabled source tracking in sandboxes. See https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_setup_enable_source_tracking_sandboxes.htm.
36
36
 
37
- - Make sure that your user can access the SourceMembers table via the tooling API.
37
+ - Make sure that your user can access the SourceMember Tooling API object.
38
38
 
39
- - If the Org is a production org, source tracking cannot be enabled.
39
+ - You can't enable source tracking on Developer Edition orgs, production orgs, Partial Copy sandboxes, or Full sandboxes.
package/oclif.lock CHANGED
@@ -961,7 +961,7 @@
961
961
  resolved "https://registry.yarnpkg.com/@pkgjs/parseargs/-/parseargs-0.11.0.tgz#a77ea742fab25775145434eb1d2328cf5013ac33"
962
962
  integrity sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==
963
963
 
964
- "@salesforce/cli-plugins-testkit@^5.0.4":
964
+ "@salesforce/cli-plugins-testkit@^5.0.3":
965
965
  version "5.0.4"
966
966
  resolved "https://registry.yarnpkg.com/@salesforce/cli-plugins-testkit/-/cli-plugins-testkit-5.0.4.tgz#523c459f43822d7b24bff5117aeda7f77ed5e26c"
967
967
  integrity sha512-8pquViVBCd5sF6nBXgLgwymEBE6pSAS376R9qq7rxuV+PSFCC5bnzQaKm2ugY+s5vXKNcV6WcmBHNCQnGv+M7Q==
@@ -1485,9 +1485,11 @@
1485
1485
  "org:disable:tracking": {
1486
1486
  "aliases": [],
1487
1487
  "args": {},
1488
- "description": "This has no effect on the org. It stores the setting in the CLI's configuration file for this org so that no source tracking operations are executed when working with this org.",
1488
+ "description": "Disabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that no source tracking operations are executed when working with the org.",
1489
1489
  "examples": [
1490
- "Disable tracking on an org using an alias\n\n- <%= config.bin %> <%= command.id %> -o someAlias\n\nDisable tracking on an org using a username\n\n- <%= config.bin %> <%= command.id %> -o you@example.com\n\nDisable tracking on your default org\n\n- <%= config.bin %> <%= command.id %>"
1490
+ "Disable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1491
+ "Disable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1492
+ "Disable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1491
1493
  ],
1492
1494
  "flags": {
1493
1495
  "json": {
@@ -1515,7 +1517,7 @@
1515
1517
  "pluginName": "@salesforce/plugin-org",
1516
1518
  "pluginType": "core",
1517
1519
  "strict": true,
1518
- "summary": "Disable source tracking in local auth file.",
1520
+ "summary": "Prevent Salesforce CLI from tracking changes in your source files between your project and an org.",
1519
1521
  "enableJsonFlag": true,
1520
1522
  "SF_ENV": "SF_ENV",
1521
1523
  "isESM": true,
@@ -1539,9 +1541,11 @@
1539
1541
  "org:enable:tracking": {
1540
1542
  "aliases": [],
1541
1543
  "args": {},
1542
- "description": "This has no effect on the org. It stores the setting in the CLI's configuration file for this org so that source tracking operations are executed when working with this org.\n\nThis command will throw an error if the org does not support tracking.",
1544
+ "description": "Enabling source tracking has no direct effect on the org, it affects only your local environment. Specifically, Salesforce CLI stores the setting in the org's local configuration file so that source tracking operations are executed when working with the org.\n\nThis command throws an error if the org doesn't support tracking. Examples of orgs that don't support source tracking include Developer Edition orgs, production orgs, Partial Copy sandboxes, and Full sandboxes.",
1543
1545
  "examples": [
1544
- "Enable tracking on an org using an alias\n\n- <%= config.bin %> <%= command.id %> -o someAlias\n\nEnable tracking on an org using a username\n\n- <%= config.bin %> <%= command.id %> -o you@example.com\n\nEnable tracking on your default org\n\n- <%= config.bin %> <%= command.id %>"
1546
+ "Enable source tracking for an org with alias \"myscratch\":\n<%= config.bin %> <%= command.id %> --target-org myscratch",
1547
+ "Enable source tracking for an org using a username:\n<%= config.bin %> <%= command.id %> --target-org you@example.com",
1548
+ "Enable source tracking for your default org:\n<%= config.bin %> <%= command.id %>"
1545
1549
  ],
1546
1550
  "flags": {
1547
1551
  "json": {
@@ -1569,7 +1573,7 @@
1569
1573
  "pluginName": "@salesforce/plugin-org",
1570
1574
  "pluginType": "core",
1571
1575
  "strict": true,
1572
- "summary": "Enable source tracking in local auth file.",
1576
+ "summary": "Allow Salesforce CLI to track changes in your source files between your project and an org.",
1573
1577
  "enableJsonFlag": true,
1574
1578
  "SF_ENV": "SF_ENV",
1575
1579
  "isESM": true,
@@ -2011,5 +2015,5 @@
2011
2015
  ]
2012
2016
  }
2013
2017
  },
2014
- "version": "3.0.6"
2018
+ "version": "3.0.7"
2015
2019
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-org",
3
3
  "description": "Commands to interact with Salesforce orgs",
4
- "version": "3.0.6",
4
+ "version": "3.0.7",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -14,7 +14,7 @@
14
14
  },
15
15
  "devDependencies": {
16
16
  "@oclif/plugin-command-snapshot": "^5.0.2",
17
- "@salesforce/cli-plugins-testkit": "^5.0.4",
17
+ "@salesforce/cli-plugins-testkit": "^5.0.3",
18
18
  "@salesforce/dev-scripts": "^7.1.1",
19
19
  "@salesforce/plugin-command-reference": "^3.0.46",
20
20
  "@salesforce/ts-sinon": "1.4.19",
@@ -72,10 +72,10 @@
72
72
  "description": "Delete scratch orgs, sandboxes, org shapes, and org snapshots."
73
73
  },
74
74
  "enable": {
75
- "description": "Enable tracking on an org."
75
+ "description": "Enable source tracking in an org."
76
76
  },
77
77
  "disable": {
78
- "description": "Disable tracking on an org"
78
+ "description": "Disable source tracking in an org."
79
79
  }
80
80
  },
81
81
  "external": true
@@ -224,7 +224,7 @@
224
224
  "exports": "./lib/index.js",
225
225
  "type": "module",
226
226
  "sfdx": {
227
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/3.0.6.crt",
228
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/3.0.6.sig"
227
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/3.0.7.crt",
228
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/3.0.7.sig"
229
229
  }
230
230
  }