@salesforce/plugin-deploy-retrieve 3.2.22 → 3.2.24

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
@@ -139,7 +139,7 @@ FLAG DESCRIPTIONS
139
139
  If you specify this parameter, don’t specify --metadata or --source-dir.
140
140
  ```
141
141
 
142
- _See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/convert/mdapi.ts)_
142
+ _See code: [src/commands/project/convert/mdapi.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/convert/mdapi.ts)_
143
143
 
144
144
  ## `sf project convert source`
145
145
 
@@ -151,7 +151,7 @@ USAGE
151
151
  <value> | -m <value>]
152
152
 
153
153
  FLAGS
154
- -d, --output-dir=<value> [default: metadataPackage_1709369074350] Output directory to store the Metadata
154
+ -d, --output-dir=<value> [default: metadataPackage_1709591436829] Output directory to store the Metadata
155
155
  API–formatted files in.
156
156
  -m, --metadata=<value>... Metadata component names to convert.
157
157
  -n, --package-name=<value> Name of the package to associate with the metadata-formatted files.
@@ -211,7 +211,7 @@ FLAG DESCRIPTIONS
211
211
  Override the api version used for api requests made by this command
212
212
  ```
213
213
 
214
- _See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/convert/source.ts)_
214
+ _See code: [src/commands/project/convert/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/convert/source.ts)_
215
215
 
216
216
  ## `sf project delete source`
217
217
 
@@ -350,7 +350,7 @@ FLAG DESCRIPTIONS
350
350
  - Separate the test names with spaces: --tests Test1 Test2 "Test With Space"
351
351
  ```
352
352
 
353
- _See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/delete/source.ts)_
353
+ _See code: [src/commands/project/delete/source.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/delete/source.ts)_
354
354
 
355
355
  ## `sf project delete tracking`
356
356
 
@@ -386,7 +386,7 @@ EXAMPLES
386
386
  $ sf project delete tracking --target-org my-scratch
387
387
  ```
388
388
 
389
- _See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/delete/tracking.ts)_
389
+ _See code: [src/commands/project/delete/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/delete/tracking.ts)_
390
390
 
391
391
  ## `sf project deploy cancel`
392
392
 
@@ -456,7 +456,7 @@ FLAG DESCRIPTIONS
456
456
  project deploy report".
457
457
  ```
458
458
 
459
- _See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/deploy/cancel.ts)_
459
+ _See code: [src/commands/project/deploy/cancel.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/deploy/cancel.ts)_
460
460
 
461
461
  ## `sf project deploy preview`
462
462
 
@@ -540,7 +540,7 @@ FLAG DESCRIPTIONS
540
540
  All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.
541
541
  ```
542
542
 
543
- _See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/deploy/preview.ts)_
543
+ _See code: [src/commands/project/deploy/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/deploy/preview.ts)_
544
544
 
545
545
  ## `sf project deploy quick`
546
546
 
@@ -624,7 +624,7 @@ FLAG DESCRIPTIONS
624
624
  deploy report".
625
625
  ```
626
626
 
627
- _See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/deploy/quick.ts)_
627
+ _See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/deploy/quick.ts)_
628
628
 
629
629
  ## `sf project deploy report`
630
630
 
@@ -719,7 +719,7 @@ FLAG DESCRIPTIONS
719
719
  --coverage-formatters lcov --coverage-formatters clover
720
720
  ```
721
721
 
722
- _See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/deploy/report.ts)_
722
+ _See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/deploy/report.ts)_
723
723
 
724
724
  ## `sf project deploy resume`
725
725
 
@@ -803,7 +803,7 @@ FLAG DESCRIPTIONS
803
803
  --coverage-formatters lcov --coverage-formatters clover
804
804
  ```
805
805
 
806
- _See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/deploy/resume.ts)_
806
+ _See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/deploy/resume.ts)_
807
807
 
808
808
  ## `sf project deploy start`
809
809
 
@@ -833,8 +833,8 @@ FLAGS
833
833
 
834
834
  SOURCE FORMAT FLAGS
835
835
  -d, --source-dir=<value>... Path to the local source files to deploy.
836
- -m, --metadata=<value>... Metadata component names to deploy. Wildcards ( `*` ) supported as long as you use
837
- quotes, such as `ApexClass:MyClass*`
836
+ -m, --metadata=<value>... Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes,
837
+ such as `ApexClass:MyClass*`.
838
838
  -x, --manifest=<value> Full file path for manifest (package.xml) of components to deploy.
839
839
 
840
840
  TEST FLAGS
@@ -859,7 +859,7 @@ DELETE FLAGS
859
859
  --post-destructive-changes=<value> File path for a manifest (destructiveChangesPost.xml) of components to delete
860
860
  after the deploy.
861
861
  --pre-destructive-changes=<value> File path for a manifest (destructiveChangesPre.xml) of components to delete
862
- before the deploy
862
+ before the deploy.
863
863
  --purge-on-delete Specify that deleted components in the destructive changes manifest file are
864
864
  immediately eligible for deletion rather than being stored in the Recycle Bin.
865
865
 
@@ -873,7 +873,7 @@ DESCRIPTION
873
873
  want to deploy.
874
874
 
875
875
  If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
876
- org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
876
+ orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
877
877
  source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create
878
878
  scratch|sandbox" commands.
879
879
 
@@ -889,29 +889,34 @@ EXAMPLES
889
889
 
890
890
  $ sf project deploy start
891
891
 
892
- Deploy the source files in a directory to an org with alias "my-scratch":
892
+ Deploy all source files in the "force-app" directory to an org with alias "my-scratch"; show only concise output, in
893
+ other words don't print a list of all the source that was deployed:
893
894
 
894
- $ sf project deploy start --source-dir path/to/source --target-org my-scratch
895
+ $ sf project deploy start --source-dir force-app --target-org my-scratch --concise
895
896
 
896
- Deploy a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
897
+ Deploy all the Apex classes and custom objects that are in the "force-app" directory. The list views, layouts, etc,
898
+ that are associated with the custom objects are also deployed. Both examples are equivalent:
897
899
 
898
- $ sf project deploy start --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
899
- $ sf project deploy start --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
900
+ $ sf project deploy start --source-dir force-app/main/default/classes force-app/main/default/objects
901
+ $ sf project deploy start --source-dir force-app/main/default/classes --source-dir \
902
+ force-app/main/default/objects
900
903
 
901
- Deploy all Apex classes:
904
+ Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
902
905
 
903
906
  $ sf project deploy start --metadata ApexClass
904
907
 
905
- Deploy a specific Apex class:
908
+ Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag,
909
+ because it will overwrite the Apex class in the org if there are conflicts!):
906
910
 
907
- $ sf project deploy start --metadata ApexClass:MyApexClass
911
+ $ sf project deploy start --metadata ApexClass:MyApexClass --ignore-conflicts
908
912
 
909
913
  Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the
910
- string "MyApex":
914
+ string "MyApex". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see
915
+ the warnings):
911
916
 
912
- $ sf project deploy start --metadata 'ApexClass:MyApex*'
917
+ $ sf project deploy start --metadata 'ApexClass:MyApex*' --ignore-warnings
913
918
 
914
- Deploy all custom objects and Apex classes (both examples are equivalent):
919
+ Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
915
920
 
916
921
  $ sf project deploy start --metadata CustomObject ApexClass
917
922
  $ sf project deploy start --metadata CustomObject --metadata ApexClass
@@ -948,8 +953,13 @@ FLAG DESCRIPTIONS
948
953
 
949
954
  -g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
950
955
 
951
- If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this
952
- flag is set to false, success is set to false, and the warning is treated like an error.
956
+ If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't
957
+ specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an
958
+ error.
959
+
960
+ This flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a
961
+ component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a
962
+ success value of true, specify this flag.
953
963
 
954
964
  -l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
955
965
 
@@ -979,9 +989,8 @@ FLAG DESCRIPTIONS
979
989
 
980
990
  -r, --ignore-errors Ignore any errors and don’t roll back deployment.
981
991
 
982
- When deploying to a production org, keep this flag set to false (default value). When set to true, components
983
- without errors are deployed and components with errors are skipped, and could result in an inconsistent production
984
- org.
992
+ Never use this flag when deploying to a production org. If you specify it, components without errors are deployed
993
+ and components with errors are skipped, and could result in an inconsistent production org.
985
994
 
986
995
  -t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
987
996
 
@@ -1015,7 +1024,7 @@ FLAG DESCRIPTIONS
1015
1024
  --coverage-formatters lcov --coverage-formatters clover
1016
1025
  ```
1017
1026
 
1018
- _See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/deploy/start.ts)_
1027
+ _See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/deploy/start.ts)_
1019
1028
 
1020
1029
  ## `sf project deploy validate`
1021
1030
 
@@ -1095,14 +1104,18 @@ ALIASES
1095
1104
  EXAMPLES
1096
1105
  NOTE: These examples focus on validating large deployments. See the help for "sf project deploy start" for examples of deploying smaller sets of metadata which you can also use to validate.
1097
1106
 
1098
- Validate the deployment of all source files in a directory to the default org:
1107
+ Validate the deployment of all source files in the "force-app" directory to the default org:
1099
1108
 
1100
- $ sf project deploy validate --source-dir path/to/source
1109
+ $ sf project deploy validate --source-dir force-app
1110
+
1111
+ Validate the deployment of all source files in two directories: "force-app" and "force-app-utils":
1112
+
1113
+ $ sf project deploy validate --source-dir force-app --source-dir force-app-utils
1101
1114
 
1102
1115
  Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately
1103
1116
  returns the job ID:
1104
1117
 
1105
- $ sf project deploy validate --source-dir path/to/source --async --test-level RunAllTestsInOrg --target-org \
1118
+ $ sf project deploy validate --source-dir force-app --async --test-level RunAllTestsInOrg --target-org \
1106
1119
  my-prod-org
1107
1120
 
1108
1121
  Validate the deployment of all components listed in a manifest:
@@ -1124,8 +1137,13 @@ FLAG DESCRIPTIONS
1124
1137
 
1125
1138
  -g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
1126
1139
 
1127
- If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this
1128
- flag is set to false, success is set to false, and the warning is treated like an error.
1140
+ If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't
1141
+ specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an
1142
+ error.
1143
+
1144
+ This flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a
1145
+ component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a
1146
+ success value of true, specify this flag.
1129
1147
 
1130
1148
  -l, --test-level=RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests Deployment Apex testing level.
1131
1149
 
@@ -1177,7 +1195,7 @@ FLAG DESCRIPTIONS
1177
1195
  --coverage-formatters lcov --coverage-formatters clover
1178
1196
  ```
1179
1197
 
1180
- _See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/deploy/validate.ts)_
1198
+ _See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/deploy/validate.ts)_
1181
1199
 
1182
1200
  ## `sf project generate manifest`
1183
1201
 
@@ -1252,7 +1270,7 @@ EXAMPLES
1252
1270
  $ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
1253
1271
  ```
1254
1272
 
1255
- _See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/generate/manifest.ts)_
1273
+ _See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/generate/manifest.ts)_
1256
1274
 
1257
1275
  ## `sf project list ignored`
1258
1276
 
@@ -1293,7 +1311,7 @@ EXAMPLES
1293
1311
  $ sf project list ignored --source-dir package.xml
1294
1312
  ```
1295
1313
 
1296
- _See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/list/ignored.ts)_
1314
+ _See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/list/ignored.ts)_
1297
1315
 
1298
1316
  ## `sf project reset tracking`
1299
1317
 
@@ -1341,7 +1359,7 @@ EXAMPLES
1341
1359
  $ sf project reset tracking --revision 30
1342
1360
  ```
1343
1361
 
1344
- _See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/reset/tracking.ts)_
1362
+ _See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/reset/tracking.ts)_
1345
1363
 
1346
1364
  ## `sf project retrieve preview`
1347
1365
 
@@ -1397,7 +1415,7 @@ FLAG DESCRIPTIONS
1397
1415
  Overrides your default org.
1398
1416
  ```
1399
1417
 
1400
- _See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/retrieve/preview.ts)_
1418
+ _See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/retrieve/preview.ts)_
1401
1419
 
1402
1420
  ## `sf project retrieve start`
1403
1421
 
@@ -1413,8 +1431,8 @@ FLAGS
1413
1431
  -c, --ignore-conflicts Ignore conflicts and retrieve and save files to your local filesystem, even if they
1414
1432
  overwrite your local changes.
1415
1433
  -d, --source-dir=<value>... File paths for source to retrieve from the org.
1416
- -m, --metadata=<value>... Metadata component names to retrieve. Wildcards ( `*` ) supported as long as you use
1417
- quotes, such as `ApexClass:MyClass*`
1434
+ -m, --metadata=<value>... Metadata component names to retrieve. Wildcards (`*`) supported as long as you use
1435
+ quotes, such as `ApexClass:MyClass*`.
1418
1436
  -n, --package-name=<value>... Package names to retrieve.
1419
1437
  -o, --target-org=<value> (required) Login username or alias for the target org.
1420
1438
  -r, --output-dir=<value> Directory root for the retrieved source files.
@@ -1440,7 +1458,7 @@ DESCRIPTION
1440
1458
  --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.
1441
1459
 
1442
1460
  If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production
1443
- org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
1461
+ orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
1444
1462
  source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create
1445
1463
  scratch|sandbox" commands.
1446
1464
 
@@ -1452,33 +1470,37 @@ ALIASES
1452
1470
  $ sf retrieve metadata
1453
1471
 
1454
1472
  EXAMPLES
1455
- Retrieve remote changes from your default org:
1473
+ Retrieve all remote changes from your default org:
1456
1474
 
1457
1475
  $ sf project retrieve start
1458
1476
 
1459
- Retrieve the source files in a directory from an org with alias "my-scratch":
1477
+ Retrieve the source files in the "force-app" directory from an org with alias "my-scratch":
1460
1478
 
1461
- $ sf project retrieve start --source-dir path/to/source --target-org my-scratch
1479
+ $ sf project retrieve start --source-dir force-app --target-org my-scratch
1462
1480
 
1463
- Retrieve a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
1481
+ Retrieve all the Apex classes and custom objects whose source is in the "force-app" directory. The list views,
1482
+ layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:
1464
1483
 
1465
- $ sf project retrieve start --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
1466
- $ sf project retrieve start --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
1484
+ $ sf project retrieve start --source-dir force-app/main/default/classes force-app/main/default/objects
1485
+ $ sf project retrieve start --source-dir force-app/main/default/classes --source-dir \
1486
+ force-app/main/default/objects
1467
1487
 
1468
- Retrieve all Apex classes:
1488
+ Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
1469
1489
 
1470
1490
  $ sf project retrieve start --metadata ApexClass
1471
1491
 
1472
- Retrieve a specific Apex class:
1492
+ Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag,
1493
+ because it will overwrite the Apex class source files in your local project if there are conflicts!):
1473
1494
 
1474
- $ sf project retrieve start --metadata ApexClass:MyApexClass
1495
+ $ sf project retrieve start --metadata ApexClass:MyApexClass --ignore-conflicts
1475
1496
 
1476
1497
  Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the
1477
1498
  string "MyApex":
1478
1499
 
1479
1500
  $ sf project retrieve start --metadata 'ApexClass:MyApex*'
1480
1501
 
1481
- Retrieve all custom objects and Apex classes (both examples are equivalent):
1502
+ Retrieve all custom objects and Apex classes found in all defined package directories (both examples are
1503
+ equivalent):
1482
1504
 
1483
1505
  $ sf project retrieve start --metadata CustomObject ApexClass
1484
1506
  $ sf project retrieve start --metadata CustomObject --metadata ApexClass
@@ -1543,6 +1565,6 @@ FLAG DESCRIPTIONS
1543
1565
  If you specify this parameter, don’t specify --metadata or --source-dir.
1544
1566
  ```
1545
1567
 
1546
- _See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.22/src/commands/project/retrieve/start.ts)_
1568
+ _See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.24/src/commands/project/retrieve/start.ts)_
1547
1569
 
1548
1570
  <!-- commandsstop -->
@@ -8,7 +8,7 @@ You must run this command from within a project.
8
8
 
9
9
  Metadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.
10
10
 
11
- If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
11
+ If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
12
12
 
13
13
  To deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
14
14
 
@@ -18,28 +18,28 @@ To deploy multiple metadata components, either set multiple --metadata <name> fl
18
18
 
19
19
  <%= config.bin %> <%= command.id %>
20
20
 
21
- - Deploy the source files in a directory to an org with alias "my-scratch":
21
+ - Deploy all source files in the "force-app" directory to an org with alias "my-scratch"; show only concise output, in other words don't print a list of all the source that was deployed:
22
22
 
23
- <%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch
23
+ <%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise
24
24
 
25
- - Deploy a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
25
+ - Deploy all the Apex classes and custom objects that are in the "force-app" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:
26
26
 
27
- <%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
28
- <%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
27
+ <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28
+ <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
29
29
 
30
- - Deploy all Apex classes:
30
+ - Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
31
31
 
32
32
  <%= config.bin %> <%= command.id %> --metadata ApexClass
33
33
 
34
- - Deploy a specific Apex class:
34
+ - Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):
35
35
 
36
- <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass
36
+ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
37
37
 
38
- - Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string "MyApex":
38
+ - Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string "MyApex". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):
39
39
 
40
- <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'
40
+ <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings
41
41
 
42
- - Deploy all custom objects and Apex classes (both examples are equivalent):
42
+ - Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
43
43
 
44
44
  <%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass
45
45
  <%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass
@@ -62,7 +62,7 @@ Login username or alias for the target org.
62
62
 
63
63
  # flags.pre-destructive-changes.summary
64
64
 
65
- File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy
65
+ File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.
66
66
 
67
67
  # flags.post-destructive-changes.summary
68
68
 
@@ -78,7 +78,7 @@ Overrides your default org.
78
78
 
79
79
  # flags.metadata.summary
80
80
 
81
- Metadata component names to deploy. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`
81
+ Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.
82
82
 
83
83
  # flags.test-level.summary
84
84
 
@@ -142,7 +142,7 @@ Ignore any errors and don’t roll back deployment.
142
142
 
143
143
  # flags.ignore-errors.description
144
144
 
145
- When deploying to a production org, keep this flag set to false (default value). When set to true, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.
145
+ Never use this flag when deploying to a production org. If you specify it, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.
146
146
 
147
147
  # flags.ignore-warnings.summary
148
148
 
@@ -150,7 +150,9 @@ Ignore warnings and allow a deployment to complete successfully.
150
150
 
151
151
  # flags.ignore-warnings.description
152
152
 
153
- If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.
153
+ If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.
154
+
155
+ This flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.
154
156
 
155
157
  # flags.verbose.summary
156
158
 
@@ -16,13 +16,17 @@ To validate the deployment of multiple metadata components, either set multiple
16
16
 
17
17
  - NOTE: These examples focus on validating large deployments. See the help for "<%= config.bin %> project deploy start" for examples of deploying smaller sets of metadata which you can also use to validate.
18
18
 
19
- - Validate the deployment of all source files in a directory to the default org:
19
+ - Validate the deployment of all source files in the "force-app" directory to the default org:
20
20
 
21
- <%= config.bin %> <%= command.id %> --source-dir path/to/source
21
+ <%= config.bin %> <%= command.id %> --source-dir force-app
22
+
23
+ - Validate the deployment of all source files in two directories: "force-app" and "force-app-utils":
24
+
25
+ <%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils
22
26
 
23
27
  - Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately returns the job ID:
24
28
 
25
- <%= config.bin %> <%= command.id %> --source-dir path/to/source --async --test-level RunAllTestsInOrg --target-org my-prod-org
29
+ <%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org
26
30
 
27
31
  - Validate the deployment of all components listed in a manifest:
28
32
 
@@ -8,38 +8,38 @@ You must run this command from within a project.
8
8
 
9
9
  Metadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.
10
10
 
11
- If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
11
+ If your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the "<%= config.bin %> org create scratch|sandbox" commands.
12
12
 
13
13
  To retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.
14
14
 
15
15
  # examples
16
16
 
17
- - Retrieve remote changes from your default org:
17
+ - Retrieve all remote changes from your default org:
18
18
 
19
19
  <%= config.bin %> <%= command.id %>
20
20
 
21
- - Retrieve the source files in a directory from an org with alias "my-scratch":
21
+ - Retrieve the source files in the "force-app" directory from an org with alias "my-scratch":
22
22
 
23
- <%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch
23
+ <%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch
24
24
 
25
- - Retrieve a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
25
+ - Retrieve all the Apex classes and custom objects whose source is in the "force-app" directory. The list views, layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:
26
26
 
27
- <%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects
28
- <%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects
27
+ <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects
28
+ <%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects
29
29
 
30
- - Retrieve all Apex classes:
30
+ - Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
31
31
 
32
32
  <%= config.bin %> <%= command.id %> --metadata ApexClass
33
33
 
34
- - Retrieve a specific Apex class:
34
+ - Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class source files in your local project if there are conflicts!):
35
35
 
36
- <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass
36
+ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts
37
37
 
38
38
  - Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string "MyApex":
39
39
 
40
40
  <%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'
41
41
 
42
- - Retrieve all custom objects and Apex classes (both examples are equivalent):
42
+ - Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
43
43
 
44
44
  <%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass
45
45
  <%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass
@@ -91,7 +91,7 @@ If you specify this parameter, don’t specify --metadata or --source-dir.
91
91
 
92
92
  # flags.metadata.summary
93
93
 
94
- Metadata component names to retrieve. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`
94
+ Metadata component names to retrieve. Wildcards (`*`) supported as long as you use quotes, such as `ApexClass:MyClass*`.
95
95
 
96
96
  # flags.package-name.summary
97
97
 
@@ -196,10 +196,10 @@ Because you're retrieving one or more CustomFields, we're also retrieving the Cu
196
196
  # noSourceTracking
197
197
 
198
198
  Unable to track changes in your source files.
199
- This command expects the org to support source tracking. If it doesn't, you must specify the metadata you want to retrieve.
199
+ This command expects the org to support source tracking. If it doesn't, you must specify the metadata you want to retrieve.
200
200
 
201
201
  # noSourceTracking.actions
202
202
 
203
- - Use the `--source-dir`, `--manifest` or `--package-name` flags to retrieve metadata in source format.
203
+ - Use the `--source-dir`, `--manifest` or `--package-name` flags to retrieve metadata in source format.
204
204
 
205
205
  - Use the `--target-metadata-dir` flag to retrieve metadata in metadata format to a directory.
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-deploy-retrieve",
3
- "version": "3.2.22",
3
+ "version": "3.2.24",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@salesforce/plugin-deploy-retrieve",
9
- "version": "3.2.22",
9
+ "version": "3.2.24",
10
10
  "license": "BSD-3-Clause",
11
11
  "dependencies": {
12
- "@oclif/core": "^3.19.6",
12
+ "@oclif/core": "^3.20.0",
13
13
  "@salesforce/apex-node": "^3.0.2",
14
14
  "@salesforce/core": "^6.4.4",
15
15
  "@salesforce/kit": "^3.0.15",
@@ -3649,9 +3649,9 @@
3649
3649
  }
3650
3650
  },
3651
3651
  "node_modules/@oclif/core": {
3652
- "version": "3.19.6",
3653
- "resolved": "https://registry.npmjs.org/@oclif/core/-/core-3.19.6.tgz",
3654
- "integrity": "sha512-1ryQWAx7VOf+Wq6pv00uilOo56DrG0drr42crmCQ3eYrPPz252EmNCoFkoOBk7McN6x0f4ega83c0yNNCXmiXw==",
3652
+ "version": "3.20.0",
3653
+ "resolved": "https://registry.npmjs.org/@oclif/core/-/core-3.20.0.tgz",
3654
+ "integrity": "sha512-8BajhglY8frYGAS1whAukeouFZUN9MgQoLfNXtScPVEAjPlaD2BbSIAYQH2yF2qb/iVvbj/1DwYS3gqicYOq1A==",
3655
3655
  "license": "MIT",
3656
3656
  "dependencies": {
3657
3657
  "@types/cli-progress": "^3.11.5",
package/oclif.lock CHANGED
@@ -1832,10 +1832,10 @@
1832
1832
  read-package-json-fast "^3.0.0"
1833
1833
  which "^3.0.0"
1834
1834
 
1835
- "@oclif/core@^3.11.0", "@oclif/core@^3.15.1", "@oclif/core@^3.18.1", "@oclif/core@^3.18.2", "@oclif/core@^3.19.1", "@oclif/core@^3.19.2", "@oclif/core@^3.19.6":
1836
- version "3.19.6"
1837
- resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.19.6.tgz#12e5cb073016d8c32c469d2fec0cd585ac5c1c09"
1838
- integrity sha512-1ryQWAx7VOf+Wq6pv00uilOo56DrG0drr42crmCQ3eYrPPz252EmNCoFkoOBk7McN6x0f4ega83c0yNNCXmiXw==
1835
+ "@oclif/core@^3.11.0", "@oclif/core@^3.15.1", "@oclif/core@^3.18.1", "@oclif/core@^3.18.2", "@oclif/core@^3.19.1", "@oclif/core@^3.19.2", "@oclif/core@^3.20.0":
1836
+ version "3.20.0"
1837
+ resolved "https://registry.yarnpkg.com/@oclif/core/-/core-3.20.0.tgz#534458dc6e8c46d8f03906aaadaca079e16a6554"
1838
+ integrity sha512-8BajhglY8frYGAS1whAukeouFZUN9MgQoLfNXtScPVEAjPlaD2BbSIAYQH2yF2qb/iVvbj/1DwYS3gqicYOq1A==
1839
1839
  dependencies:
1840
1840
  "@types/cli-progress" "^3.11.5"
1841
1841
  ansi-escapes "^4.3.2"
@@ -202,7 +202,7 @@
202
202
  "deprecateAliases": true,
203
203
  "name": "output-dir",
204
204
  "summary": "Output directory to store the Metadata API–formatted files in.",
205
- "default": "metadataPackage_1709369346185",
205
+ "default": "metadataPackage_1709591623974",
206
206
  "hasDynamicHelp": false,
207
207
  "multiple": false,
208
208
  "type": "option"
@@ -1344,15 +1344,15 @@
1344
1344
  ],
1345
1345
  "args": {},
1346
1346
  "deprecateAliases": true,
1347
- "description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
1347
+ "description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo deploy multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
1348
1348
  "examples": [
1349
1349
  "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1350
- "Deploy the source files in a directory to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch",
1351
- "Deploy a specific Apex class and the objects whose source is in a directory (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects",
1352
- "Deploy all Apex classes:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1353
- "Deploy a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
1354
- "Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\":\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'",
1355
- "Deploy all custom objects and Apex classes (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
1350
+ "Deploy all source files in the \"force-app\" directory to an org with alias \"my-scratch\"; show only concise output, in other words don't print a list of all the source that was deployed:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise",
1351
+ "Deploy all the Apex classes and custom objects that are in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
1352
+ "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1353
+ "Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
1354
+ "Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
1355
+ "Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
1356
1356
  "Deploy all Apex classes and a profile that has a space in its name:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
1357
1357
  "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
1358
1358
  "Run the tests that aren’t in any managed packages as part of a deployment:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests"
@@ -1409,7 +1409,7 @@
1409
1409
  },
1410
1410
  "ignore-errors": {
1411
1411
  "char": "r",
1412
- "description": "When deploying to a production org, keep this flag set to false (default value). When set to true, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
1412
+ "description": "Never use this flag when deploying to a production org. If you specify it, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
1413
1413
  "name": "ignore-errors",
1414
1414
  "summary": "Ignore any errors and don’t roll back deployment.",
1415
1415
  "allowNo": false,
@@ -1417,7 +1417,7 @@
1417
1417
  },
1418
1418
  "ignore-warnings": {
1419
1419
  "char": "g",
1420
- "description": "If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.",
1420
+ "description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
1421
1421
  "name": "ignore-warnings",
1422
1422
  "summary": "Ignore warnings and allow a deployment to complete successfully.",
1423
1423
  "allowNo": false,
@@ -1447,7 +1447,7 @@
1447
1447
  ],
1448
1448
  "helpGroup": "Source Format",
1449
1449
  "name": "metadata",
1450
- "summary": "Metadata component names to deploy. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
1450
+ "summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
1451
1451
  "hasDynamicHelp": false,
1452
1452
  "multiple": true,
1453
1453
  "type": "option"
@@ -1578,7 +1578,7 @@
1578
1578
  ],
1579
1579
  "helpGroup": "Delete",
1580
1580
  "name": "pre-destructive-changes",
1581
- "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1581
+ "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
1582
1582
  "hasDynamicHelp": false,
1583
1583
  "multiple": false,
1584
1584
  "type": "option"
@@ -1739,8 +1739,9 @@
1739
1739
  "description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"<%= config.bin %> project deploy start\", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the \"<%= config.bin %> project deploy quick\" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nYou must run this command from within a project.\n\nThis command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.\n\nTo validate the deployment of multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
1740
1740
  "examples": [
1741
1741
  "NOTE: These examples focus on validating large deployments. See the help for \"<%= config.bin %> project deploy start\" for examples of deploying smaller sets of metadata which you can also use to validate.",
1742
- "Validate the deployment of all source files in a directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir path/to/source",
1743
- "Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\n<%= config.bin %> <%= command.id %> --source-dir path/to/source --async --test-level RunAllTestsInOrg --target-org my-prod-org",
1742
+ "Validate the deployment of all source files in the \"force-app\" directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
1743
+ "Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils",
1744
+ "Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\n<%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
1744
1745
  "Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
1745
1746
  ],
1746
1747
  "flags": {
@@ -1885,7 +1886,7 @@
1885
1886
  },
1886
1887
  "ignore-warnings": {
1887
1888
  "char": "g",
1888
- "description": "If a warning occurs and this flag is set to true, the success status of the deployment is set to true. When this flag is set to false, success is set to false, and the warning is treated like an error.",
1889
+ "description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
1889
1890
  "name": "ignore-warnings",
1890
1891
  "summary": "Ignore warnings and allow a deployment to complete successfully.",
1891
1892
  "allowNo": false,
@@ -2570,15 +2571,15 @@
2570
2571
  ],
2571
2572
  "args": {},
2572
2573
  "deprecateAliases": true,
2573
- "description": "You must run this command from within a project.\n\nMetadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
2574
+ "description": "You must run this command from within a project.\n\nMetadata components are retrieved in source format by default. Retrieve them in metadata format by specifying the --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo retrieve multiple metadata components, either use multiple --metadata <name> flags or use a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
2574
2575
  "examples": [
2575
- "Retrieve remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
2576
- "Retrieve the source files in a directory from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch",
2577
- "Retrieve a specific Apex class and the objects whose source is in a directory (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects",
2578
- "Retrieve all Apex classes:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
2579
- "Retrieve a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
2576
+ "Retrieve all remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
2577
+ "Retrieve the source files in the \"force-app\" directory from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch",
2578
+ "Retrieve all the Apex classes and custom objects whose source is in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
2579
+ "Retrieve all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
2580
+ "Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class source files in your local project if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
2580
2581
  "Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the string \"MyApex\":\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*'",
2581
- "Retrieve all custom objects and Apex classes (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
2582
+ "Retrieve all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
2582
2583
  "Retrieve all metadata components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
2583
2584
  "Retrieve metadata from a package:\n<%= config.bin %> <%= command.id %> --package-name MyPackageName",
2584
2585
  "Retrieve metadata from multiple packages, one of which has a space in its name (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --package-name Package1 \"PackageName With Spaces\" Package3\n<%= config.bin %> <%= command.id %> --package-name Package1 --package-name \"PackageName With Spaces\" --package-name Package3",
@@ -2630,7 +2631,7 @@
2630
2631
  "source-dir"
2631
2632
  ],
2632
2633
  "name": "metadata",
2633
- "summary": "Metadata component names to retrieve. Wildcards ( `*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`",
2634
+ "summary": "Metadata component names to retrieve. Wildcards (`*`) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
2634
2635
  "hasDynamicHelp": false,
2635
2636
  "multiple": true,
2636
2637
  "type": "option"
@@ -2815,5 +2816,5 @@
2815
2816
  ]
2816
2817
  }
2817
2818
  },
2818
- "version": "3.2.22"
2819
+ "version": "3.2.24"
2819
2820
  }
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-deploy-retrieve",
3
3
  "description": "deploy and retrieve commands for sf",
4
- "version": "3.2.22",
4
+ "version": "3.2.24",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
8
- "@oclif/core": "^3.19.6",
8
+ "@oclif/core": "^3.20.0",
9
9
  "@salesforce/apex-node": "^3.0.2",
10
10
  "@salesforce/core": "^6.4.4",
11
11
  "@salesforce/kit": "^3.0.15",
@@ -252,7 +252,7 @@
252
252
  "exports": "./lib/index.js",
253
253
  "type": "module",
254
254
  "sfdx": {
255
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.2.22.crt",
256
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.2.22.sig"
255
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.2.24.crt",
256
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/3.2.24.sig"
257
257
  }
258
258
  }