@salesforce/plugin-deploy-retrieve 3.2.23 → 3.2.25

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.23/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.25/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_1709379859643] Output directory to store the Metadata
154
+ -d, --output-dir=<value> [default: metadataPackage_1709594157769] 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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/src/commands/project/deploy/preview.ts)_
544
544
 
545
545
  ## `sf project deploy quick`
546
546
 
@@ -580,6 +580,9 @@ DESCRIPTION
580
580
  This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org.
581
581
  This command doesn’t attempt to merge your source with the versions in your org.
582
582
 
583
+ Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default,
584
+ sandboxes don't run tests during a deploy. Use `sf project deploy start` instead.
585
+
583
586
  ALIASES
584
587
  $ sf deploy metadata quick
585
588
 
@@ -624,7 +627,7 @@ FLAG DESCRIPTIONS
624
627
  deploy report".
625
628
  ```
626
629
 
627
- _See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/quick.ts)_
630
+ _See code: [src/commands/project/deploy/quick.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/quick.ts)_
628
631
 
629
632
  ## `sf project deploy report`
630
633
 
@@ -719,7 +722,7 @@ FLAG DESCRIPTIONS
719
722
  --coverage-formatters lcov --coverage-formatters clover
720
723
  ```
721
724
 
722
- _See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/report.ts)_
725
+ _See code: [src/commands/project/deploy/report.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/report.ts)_
723
726
 
724
727
  ## `sf project deploy resume`
725
728
 
@@ -803,7 +806,7 @@ FLAG DESCRIPTIONS
803
806
  --coverage-formatters lcov --coverage-formatters clover
804
807
  ```
805
808
 
806
- _See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/resume.ts)_
809
+ _See code: [src/commands/project/deploy/resume.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/resume.ts)_
807
810
 
808
811
  ## `sf project deploy start`
809
812
 
@@ -833,8 +836,8 @@ FLAGS
833
836
 
834
837
  SOURCE FORMAT FLAGS
835
838
  -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*`
839
+ -m, --metadata=<value>... Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes,
840
+ such as `ApexClass:MyClass*`.
838
841
  -x, --manifest=<value> Full file path for manifest (package.xml) of components to deploy.
839
842
 
840
843
  TEST FLAGS
@@ -859,7 +862,7 @@ DELETE FLAGS
859
862
  --post-destructive-changes=<value> File path for a manifest (destructiveChangesPost.xml) of components to delete
860
863
  after the deploy.
861
864
  --pre-destructive-changes=<value> File path for a manifest (destructiveChangesPre.xml) of components to delete
862
- before the deploy
865
+ before the deploy.
863
866
  --purge-on-delete Specify that deleted components in the destructive changes manifest file are
864
867
  immediately eligible for deletion rather than being stored in the Recycle Bin.
865
868
 
@@ -873,7 +876,7 @@ DESCRIPTION
873
876
  want to deploy.
874
877
 
875
878
  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
879
+ orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
877
880
  source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create
878
881
  scratch|sandbox" commands.
879
882
 
@@ -889,29 +892,34 @@ EXAMPLES
889
892
 
890
893
  $ sf project deploy start
891
894
 
892
- Deploy the source files in a directory to an org with alias "my-scratch":
895
+ Deploy all source files in the "force-app" directory to an org with alias "my-scratch"; show only concise output, in
896
+ other words don't print a list of all the source that was deployed:
893
897
 
894
- $ sf project deploy start --source-dir path/to/source --target-org my-scratch
898
+ $ sf project deploy start --source-dir force-app --target-org my-scratch --concise
895
899
 
896
- Deploy a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
900
+ Deploy all the Apex classes and custom objects that are in the "force-app" directory. The list views, layouts, etc,
901
+ that are associated with the custom objects are also deployed. Both examples are equivalent:
897
902
 
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
903
+ $ sf project deploy start --source-dir force-app/main/default/classes force-app/main/default/objects
904
+ $ sf project deploy start --source-dir force-app/main/default/classes --source-dir \
905
+ force-app/main/default/objects
900
906
 
901
- Deploy all Apex classes:
907
+ Deploy all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
902
908
 
903
909
  $ sf project deploy start --metadata ApexClass
904
910
 
905
- Deploy a specific Apex class:
911
+ Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag,
912
+ because it will overwrite the Apex class in the org if there are conflicts!):
906
913
 
907
- $ sf project deploy start --metadata ApexClass:MyApexClass
914
+ $ sf project deploy start --metadata ApexClass:MyApexClass --ignore-conflicts
908
915
 
909
916
  Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the
910
- string "MyApex":
917
+ string "MyApex". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see
918
+ the warnings):
911
919
 
912
- $ sf project deploy start --metadata 'ApexClass:MyApex*'
920
+ $ sf project deploy start --metadata 'ApexClass:MyApex*' --ignore-warnings
913
921
 
914
- Deploy all custom objects and Apex classes (both examples are equivalent):
922
+ Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):
915
923
 
916
924
  $ sf project deploy start --metadata CustomObject ApexClass
917
925
  $ sf project deploy start --metadata CustomObject --metadata ApexClass
@@ -948,8 +956,13 @@ FLAG DESCRIPTIONS
948
956
 
949
957
  -g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
950
958
 
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.
959
+ If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't
960
+ specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an
961
+ error.
962
+
963
+ This flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a
964
+ component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a
965
+ success value of true, specify this flag.
953
966
 
954
967
  -l, --test-level=NoTestRun|RunSpecifiedTests|RunLocalTests|RunAllTestsInOrg Deployment Apex testing level.
955
968
 
@@ -979,9 +992,8 @@ FLAG DESCRIPTIONS
979
992
 
980
993
  -r, --ignore-errors Ignore any errors and don’t roll back deployment.
981
994
 
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.
995
+ Never use this flag when deploying to a production org. If you specify it, components without errors are deployed
996
+ and components with errors are skipped, and could result in an inconsistent production org.
985
997
 
986
998
  -t, --tests=<value>... Apex tests to run when --test-level is RunSpecifiedTests.
987
999
 
@@ -1015,7 +1027,7 @@ FLAG DESCRIPTIONS
1015
1027
  --coverage-formatters lcov --coverage-formatters clover
1016
1028
  ```
1017
1029
 
1018
- _See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/start.ts)_
1030
+ _See code: [src/commands/project/deploy/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/start.ts)_
1019
1031
 
1020
1032
  ## `sf project deploy validate`
1021
1033
 
@@ -1089,20 +1101,28 @@ DESCRIPTION
1089
1101
  --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double
1090
1102
  quotes. The same syntax applies to --manifest and --source-dir.
1091
1103
 
1104
+ Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default,
1105
+ sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use "sf
1106
+ project deploy start --dry-run --test-level RunLocalTests" instead.
1107
+
1092
1108
  ALIASES
1093
1109
  $ sf deploy metadata validate
1094
1110
 
1095
1111
  EXAMPLES
1096
1112
  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
1113
 
1098
- Validate the deployment of all source files in a directory to the default org:
1114
+ Validate the deployment of all source files in the "force-app" directory to the default org:
1115
+
1116
+ $ sf project deploy validate --source-dir force-app
1099
1117
 
1100
- $ sf project deploy validate --source-dir path/to/source
1118
+ Validate the deployment of all source files in two directories: "force-app" and "force-app-utils":
1119
+
1120
+ $ sf project deploy validate --source-dir force-app --source-dir force-app-utils
1101
1121
 
1102
1122
  Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately
1103
1123
  returns the job ID:
1104
1124
 
1105
- $ sf project deploy validate --source-dir path/to/source --async --test-level RunAllTestsInOrg --target-org \
1125
+ $ sf project deploy validate --source-dir force-app --async --test-level RunAllTestsInOrg --target-org \
1106
1126
  my-prod-org
1107
1127
 
1108
1128
  Validate the deployment of all components listed in a manifest:
@@ -1124,8 +1144,13 @@ FLAG DESCRIPTIONS
1124
1144
 
1125
1145
  -g, --ignore-warnings Ignore warnings and allow a deployment to complete successfully.
1126
1146
 
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.
1147
+ If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't
1148
+ specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an
1149
+ error.
1150
+
1151
+ This flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a
1152
+ component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a
1153
+ success value of true, specify this flag.
1129
1154
 
1130
1155
  -l, --test-level=RunAllTestsInOrg|RunLocalTests|RunSpecifiedTests Deployment Apex testing level.
1131
1156
 
@@ -1177,7 +1202,7 @@ FLAG DESCRIPTIONS
1177
1202
  --coverage-formatters lcov --coverage-formatters clover
1178
1203
  ```
1179
1204
 
1180
- _See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/deploy/validate.ts)_
1205
+ _See code: [src/commands/project/deploy/validate.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/deploy/validate.ts)_
1181
1206
 
1182
1207
  ## `sf project generate manifest`
1183
1208
 
@@ -1252,7 +1277,7 @@ EXAMPLES
1252
1277
  $ sf project generate manifest --from-org test@myorg.com --include-packages unlocked
1253
1278
  ```
1254
1279
 
1255
- _See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/generate/manifest.ts)_
1280
+ _See code: [src/commands/project/generate/manifest.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/generate/manifest.ts)_
1256
1281
 
1257
1282
  ## `sf project list ignored`
1258
1283
 
@@ -1293,7 +1318,7 @@ EXAMPLES
1293
1318
  $ sf project list ignored --source-dir package.xml
1294
1319
  ```
1295
1320
 
1296
- _See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/list/ignored.ts)_
1321
+ _See code: [src/commands/project/list/ignored.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/list/ignored.ts)_
1297
1322
 
1298
1323
  ## `sf project reset tracking`
1299
1324
 
@@ -1341,7 +1366,7 @@ EXAMPLES
1341
1366
  $ sf project reset tracking --revision 30
1342
1367
  ```
1343
1368
 
1344
- _See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/reset/tracking.ts)_
1369
+ _See code: [src/commands/project/reset/tracking.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/reset/tracking.ts)_
1345
1370
 
1346
1371
  ## `sf project retrieve preview`
1347
1372
 
@@ -1397,7 +1422,7 @@ FLAG DESCRIPTIONS
1397
1422
  Overrides your default org.
1398
1423
  ```
1399
1424
 
1400
- _See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/retrieve/preview.ts)_
1425
+ _See code: [src/commands/project/retrieve/preview.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/retrieve/preview.ts)_
1401
1426
 
1402
1427
  ## `sf project retrieve start`
1403
1428
 
@@ -1413,8 +1438,8 @@ FLAGS
1413
1438
  -c, --ignore-conflicts Ignore conflicts and retrieve and save files to your local filesystem, even if they
1414
1439
  overwrite your local changes.
1415
1440
  -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*`
1441
+ -m, --metadata=<value>... Metadata component names to retrieve. Wildcards (`*`) supported as long as you use
1442
+ quotes, such as `ApexClass:MyClass*`.
1418
1443
  -n, --package-name=<value>... Package names to retrieve.
1419
1444
  -o, --target-org=<value> (required) Login username or alias for the target org.
1420
1445
  -r, --output-dir=<value> Directory root for the retrieved source files.
@@ -1440,7 +1465,7 @@ DESCRIPTION
1440
1465
  --target-metadata-dir flag, which retrieves the components into a ZIP file in the specified directory.
1441
1466
 
1442
1467
  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
1468
+ orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable
1444
1469
  source tracking when you create the orgs by specifying the --no-track-source flag on the "sf org create
1445
1470
  scratch|sandbox" commands.
1446
1471
 
@@ -1452,33 +1477,37 @@ ALIASES
1452
1477
  $ sf retrieve metadata
1453
1478
 
1454
1479
  EXAMPLES
1455
- Retrieve remote changes from your default org:
1480
+ Retrieve all remote changes from your default org:
1456
1481
 
1457
1482
  $ sf project retrieve start
1458
1483
 
1459
- Retrieve the source files in a directory from an org with alias "my-scratch":
1484
+ Retrieve the source files in the "force-app" directory from an org with alias "my-scratch":
1460
1485
 
1461
- $ sf project retrieve start --source-dir path/to/source --target-org my-scratch
1486
+ $ sf project retrieve start --source-dir force-app --target-org my-scratch
1462
1487
 
1463
- Retrieve a specific Apex class and the objects whose source is in a directory (both examples are equivalent):
1488
+ Retrieve all the Apex classes and custom objects whose source is in the "force-app" directory. The list views,
1489
+ layouts, etc, that are associated with the custom objects are also retrieved. Both examples are equivalent:
1464
1490
 
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
1491
+ $ sf project retrieve start --source-dir force-app/main/default/classes force-app/main/default/objects
1492
+ $ sf project retrieve start --source-dir force-app/main/default/classes --source-dir \
1493
+ force-app/main/default/objects
1467
1494
 
1468
- Retrieve all Apex classes:
1495
+ Retrieve all Apex classes that are in all package directories defined in the "sfdx-project.json" file:
1469
1496
 
1470
1497
  $ sf project retrieve start --metadata ApexClass
1471
1498
 
1472
- Retrieve a specific Apex class:
1499
+ Retrieve a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag,
1500
+ because it will overwrite the Apex class source files in your local project if there are conflicts!):
1473
1501
 
1474
- $ sf project retrieve start --metadata ApexClass:MyApexClass
1502
+ $ sf project retrieve start --metadata ApexClass:MyApexClass --ignore-conflicts
1475
1503
 
1476
1504
  Retrieve specific Apex classes that match a pattern; in this example, retrieve Apex classes whose names contain the
1477
1505
  string "MyApex":
1478
1506
 
1479
1507
  $ sf project retrieve start --metadata 'ApexClass:MyApex*'
1480
1508
 
1481
- Retrieve all custom objects and Apex classes (both examples are equivalent):
1509
+ Retrieve all custom objects and Apex classes found in all defined package directories (both examples are
1510
+ equivalent):
1482
1511
 
1483
1512
  $ sf project retrieve start --metadata CustomObject ApexClass
1484
1513
  $ sf project retrieve start --metadata CustomObject --metadata ApexClass
@@ -1543,6 +1572,6 @@ FLAG DESCRIPTIONS
1543
1572
  If you specify this parameter, don’t specify --metadata or --source-dir.
1544
1573
  ```
1545
1574
 
1546
- _See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.23/src/commands/project/retrieve/start.ts)_
1575
+ _See code: [src/commands/project/retrieve/start.ts](https://github.com/salesforcecli/plugin-deploy-retrieve/blob/3.2.25/src/commands/project/retrieve/start.ts)_
1547
1576
 
1548
1577
  <!-- 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
 
@@ -10,6 +10,8 @@ Executing this quick deploy command takes less time than a standard deploy becau
10
10
 
11
11
  This command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.
12
12
 
13
+ Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. Use `sf project deploy start` instead.
14
+
13
15
  # examples
14
16
 
15
17
  - Run a quick deploy to your default org using a job ID:
@@ -12,17 +12,23 @@ This command doesn't support source-tracking. When you quick deploy with the res
12
12
 
13
13
  To 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.
14
14
 
15
+ Note: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use "sf project deploy start --dry-run --test-level RunLocalTests" instead.
16
+
15
17
  # examples
16
18
 
17
19
  - 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
20
 
19
- - Validate the deployment of all source files in a directory to the default org:
21
+ - Validate the deployment of all source files in the "force-app" directory to the default org:
22
+
23
+ <%= config.bin %> <%= command.id %> --source-dir force-app
24
+
25
+ - Validate the deployment of all source files in two directories: "force-app" and "force-app-utils":
20
26
 
21
- <%= config.bin %> <%= command.id %> --source-dir path/to/source
27
+ <%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils
22
28
 
23
29
  - Asynchronously validate the deployment and run all tests in the org with alias "my-prod-org"; command immediately returns the job ID:
24
30
 
25
- <%= config.bin %> <%= command.id %> --source-dir path/to/source --async --test-level RunAllTestsInOrg --target-org my-prod-org
31
+ <%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org
26
32
 
27
33
  - Validate the deployment of all components listed in a manifest:
28
34
 
@@ -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,12 +1,12 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-deploy-retrieve",
3
- "version": "3.2.23",
3
+ "version": "3.2.25",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@salesforce/plugin-deploy-retrieve",
9
- "version": "3.2.23",
9
+ "version": "3.2.25",
10
10
  "license": "BSD-3-Clause",
11
11
  "dependencies": {
12
12
  "@oclif/core": "^3.20.0",