@salesforce/plugin-packaging 2.24.1 → 2.24.3
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 +39 -34
- package/messages/bundle_create.md +6 -7
- package/messages/bundle_install.md +10 -14
- package/messages/bundle_install_list.md +7 -7
- package/messages/bundle_install_report.md +5 -9
- package/messages/bundle_list.md +9 -9
- package/messages/bundle_version_create.md +16 -12
- package/messages/bundle_version_create_list.md +13 -13
- package/messages/bundle_version_create_report.md +5 -9
- package/messages/bundle_version_list.md +6 -6
- package/messages/bundle_version_report.md +5 -5
- package/messages/package_bundle_delete.md +2 -4
- package/messages/package_update.md +3 -2
- package/oclif.manifest.json +47 -50
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -155,7 +155,7 @@ FLAG DESCRIPTIONS
|
|
|
155
155
|
--installation-key-bypass flag is required.
|
|
156
156
|
```
|
|
157
157
|
|
|
158
|
-
_See code: [src/commands/package/convert.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
158
|
+
_See code: [src/commands/package/convert.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/convert.ts)_
|
|
159
159
|
|
|
160
160
|
## `sf package create`
|
|
161
161
|
|
|
@@ -234,7 +234,7 @@ FLAG DESCRIPTIONS
|
|
|
234
234
|
Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
|
|
235
235
|
```
|
|
236
236
|
|
|
237
|
-
_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
237
|
+
_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/create.ts)_
|
|
238
238
|
|
|
239
239
|
## `sf package delete`
|
|
240
240
|
|
|
@@ -276,7 +276,7 @@ EXAMPLES
|
|
|
276
276
|
$ sf package delete --package 0Ho... --target-dev-hub devhub@example.com
|
|
277
277
|
```
|
|
278
278
|
|
|
279
|
-
_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
279
|
+
_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/delete.ts)_
|
|
280
280
|
|
|
281
281
|
## `sf package install`
|
|
282
282
|
|
|
@@ -375,7 +375,7 @@ FLAG DESCRIPTIONS
|
|
|
375
375
|
- Delete: Delete removed components, except for custom objects and custom fields, that don't have dependencies.
|
|
376
376
|
```
|
|
377
377
|
|
|
378
|
-
_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
378
|
+
_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/install.ts)_
|
|
379
379
|
|
|
380
380
|
## `sf package install report`
|
|
381
381
|
|
|
@@ -408,7 +408,7 @@ EXAMPLES
|
|
|
408
408
|
$ sf package install report --request-id 0Hf... --target-org me@example.com
|
|
409
409
|
```
|
|
410
410
|
|
|
411
|
-
_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
411
|
+
_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/install/report.ts)_
|
|
412
412
|
|
|
413
413
|
## `sf package installed list`
|
|
414
414
|
|
|
@@ -440,7 +440,7 @@ EXAMPLES
|
|
|
440
440
|
$ sf package installed list --target-org me@example.com
|
|
441
441
|
```
|
|
442
442
|
|
|
443
|
-
_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
443
|
+
_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/installed/list.ts)_
|
|
444
444
|
|
|
445
445
|
## `sf package list`
|
|
446
446
|
|
|
@@ -478,7 +478,7 @@ EXAMPLES
|
|
|
478
478
|
$ sf package list --target-dev-hub devhub@example.com --verbose
|
|
479
479
|
```
|
|
480
480
|
|
|
481
|
-
_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
481
|
+
_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/list.ts)_
|
|
482
482
|
|
|
483
483
|
## `sf package push-upgrade abort`
|
|
484
484
|
|
|
@@ -517,7 +517,7 @@ EXAMPLES
|
|
|
517
517
|
$ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com
|
|
518
518
|
```
|
|
519
519
|
|
|
520
|
-
_See code: [src/commands/package/push-upgrade/abort.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
520
|
+
_See code: [src/commands/package/push-upgrade/abort.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/push-upgrade/abort.ts)_
|
|
521
521
|
|
|
522
522
|
## `sf package push-upgrade list`
|
|
523
523
|
|
|
@@ -576,7 +576,7 @@ EXAMPLES
|
|
|
576
576
|
$ sf package push-upgrade list --package 033xyz –-status Failed
|
|
577
577
|
```
|
|
578
578
|
|
|
579
|
-
_See code: [src/commands/package/push-upgrade/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
579
|
+
_See code: [src/commands/package/push-upgrade/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/push-upgrade/list.ts)_
|
|
580
580
|
|
|
581
581
|
## `sf package push-upgrade report`
|
|
582
582
|
|
|
@@ -618,7 +618,7 @@ EXAMPLES
|
|
|
618
618
|
$ sf package push-upgrade report --push-request-id 0DV... --target-dev-hub devhub@example.com
|
|
619
619
|
```
|
|
620
620
|
|
|
621
|
-
_See code: [src/commands/package/push-upgrade/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
621
|
+
_See code: [src/commands/package/push-upgrade/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/push-upgrade/report.ts)_
|
|
622
622
|
|
|
623
623
|
## `sf package push-upgrade schedule`
|
|
624
624
|
|
|
@@ -705,7 +705,7 @@ FLAG DESCRIPTIONS
|
|
|
705
705
|
Overrides the value of the target-dev-hub configuration variable, if set.
|
|
706
706
|
```
|
|
707
707
|
|
|
708
|
-
_See code: [src/commands/package/push-upgrade/schedule.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
708
|
+
_See code: [src/commands/package/push-upgrade/schedule.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/push-upgrade/schedule.ts)_
|
|
709
709
|
|
|
710
710
|
## `sf package uninstall`
|
|
711
711
|
|
|
@@ -753,7 +753,7 @@ EXAMPLES
|
|
|
753
753
|
$ sf package uninstall --package "Undesirable Package Alias"
|
|
754
754
|
```
|
|
755
755
|
|
|
756
|
-
_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
756
|
+
_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/uninstall.ts)_
|
|
757
757
|
|
|
758
758
|
## `sf package uninstall report`
|
|
759
759
|
|
|
@@ -786,7 +786,7 @@ EXAMPLES
|
|
|
786
786
|
$ sf package uninstall report --request-id 06y... --target-org me@example.com
|
|
787
787
|
```
|
|
788
788
|
|
|
789
|
-
_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
789
|
+
_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/uninstall/report.ts)_
|
|
790
790
|
|
|
791
791
|
## `sf package update`
|
|
792
792
|
|
|
@@ -803,7 +803,9 @@ FLAGS
|
|
|
803
803
|
-o, --error-notification-username=<value> Active Dev Hub user designated to receive email notifications for package
|
|
804
804
|
errors.
|
|
805
805
|
-p, --package=<value> (required) ID (starts with 0Ho) or alias of the package to update.
|
|
806
|
-
-r, --recommended-version-id=<value>
|
|
806
|
+
-r, --recommended-version-id=<value> ID of the package version that's installed when subscribers click the
|
|
807
|
+
Upgrade to Recommended Version option on the Installed Package page of
|
|
808
|
+
their org.
|
|
807
809
|
-v, --target-dev-hub=<value> (required) Username or alias of the Dev Hub org. Not required if the
|
|
808
810
|
`target-dev-hub` configuration variable is already set.
|
|
809
811
|
--api-version=<value> Override the api version used for api requests made by this command
|
|
@@ -842,14 +844,17 @@ FLAG DESCRIPTIONS
|
|
|
842
844
|
Email notifications include information about unhandled Apex exceptions, and install, upgrade, or uninstall failures
|
|
843
845
|
associated with your package.
|
|
844
846
|
|
|
845
|
-
-r, --recommended-version-id=<value>
|
|
847
|
+
-r, --recommended-version-id=<value>
|
|
846
848
|
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
849
|
+
ID of the package version that's installed when subscribers click the Upgrade to Recommended Version option on the
|
|
850
|
+
Installed Package page of their org.
|
|
851
|
+
|
|
852
|
+
Specify the recommended package version for subscribers to install. If a subscriber has a package version installed
|
|
853
|
+
in their org that's lower than the version you set, the subscriber sees the Upgrade to Recommended Version option on
|
|
854
|
+
the Installed Package page. Only released package versions can be set as the recommended version.
|
|
850
855
|
```
|
|
851
856
|
|
|
852
|
-
_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
857
|
+
_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/update.ts)_
|
|
853
858
|
|
|
854
859
|
## `sf package version create`
|
|
855
860
|
|
|
@@ -1024,7 +1029,7 @@ FLAG DESCRIPTIONS
|
|
|
1024
1029
|
periods of no output from commands.
|
|
1025
1030
|
```
|
|
1026
1031
|
|
|
1027
|
-
_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1032
|
+
_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/create.ts)_
|
|
1028
1033
|
|
|
1029
1034
|
## `sf package version create list`
|
|
1030
1035
|
|
|
@@ -1085,7 +1090,7 @@ EXAMPLES
|
|
|
1085
1090
|
$ sf package version create list --created-last-days 0 --status Success
|
|
1086
1091
|
```
|
|
1087
1092
|
|
|
1088
|
-
_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1093
|
+
_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/create/list.ts)_
|
|
1089
1094
|
|
|
1090
1095
|
## `sf package version create report`
|
|
1091
1096
|
|
|
@@ -1128,7 +1133,7 @@ EXAMPLES
|
|
|
1128
1133
|
$ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
|
|
1129
1134
|
```
|
|
1130
1135
|
|
|
1131
|
-
_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1136
|
+
_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/create/report.ts)_
|
|
1132
1137
|
|
|
1133
1138
|
## `sf package version delete`
|
|
1134
1139
|
|
|
@@ -1169,7 +1174,7 @@ EXAMPLES
|
|
|
1169
1174
|
$ sf package version delete --package 04t... --target-org devhub@example.com
|
|
1170
1175
|
```
|
|
1171
1176
|
|
|
1172
|
-
_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1177
|
+
_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/delete.ts)_
|
|
1173
1178
|
|
|
1174
1179
|
## `sf package version displayancestry`
|
|
1175
1180
|
|
|
@@ -1229,7 +1234,7 @@ FLAG DESCRIPTIONS
|
|
|
1229
1234
|
You can use the DOT code output in graph visualization software to create tree visualizations.
|
|
1230
1235
|
```
|
|
1231
1236
|
|
|
1232
|
-
_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1237
|
+
_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/displayancestry.ts)_
|
|
1233
1238
|
|
|
1234
1239
|
## `sf package version displaydependencies`
|
|
1235
1240
|
|
|
@@ -1291,7 +1296,7 @@ FLAG DESCRIPTIONS
|
|
|
1291
1296
|
package, which must be installed last.
|
|
1292
1297
|
```
|
|
1293
1298
|
|
|
1294
|
-
_See code: [src/commands/package/version/displaydependencies.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1299
|
+
_See code: [src/commands/package/version/displaydependencies.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/displaydependencies.ts)_
|
|
1295
1300
|
|
|
1296
1301
|
## `sf package version list`
|
|
1297
1302
|
|
|
@@ -1367,7 +1372,7 @@ EXAMPLES
|
|
|
1367
1372
|
$ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
|
|
1368
1373
|
```
|
|
1369
1374
|
|
|
1370
|
-
_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1375
|
+
_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/list.ts)_
|
|
1371
1376
|
|
|
1372
1377
|
## `sf package version promote`
|
|
1373
1378
|
|
|
@@ -1411,7 +1416,7 @@ EXAMPLES
|
|
|
1411
1416
|
$ sf package version promote --package "Awesome Package Alias"
|
|
1412
1417
|
```
|
|
1413
1418
|
|
|
1414
|
-
_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1419
|
+
_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/promote.ts)_
|
|
1415
1420
|
|
|
1416
1421
|
## `sf package version report`
|
|
1417
1422
|
|
|
@@ -1451,7 +1456,7 @@ EXAMPLES
|
|
|
1451
1456
|
$ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
|
|
1452
1457
|
```
|
|
1453
1458
|
|
|
1454
|
-
_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1459
|
+
_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/report.ts)_
|
|
1455
1460
|
|
|
1456
1461
|
## `sf package version retrieve`
|
|
1457
1462
|
|
|
@@ -1496,7 +1501,7 @@ EXAMPLES
|
|
|
1496
1501
|
$ sf package version retrieve --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com
|
|
1497
1502
|
```
|
|
1498
1503
|
|
|
1499
|
-
_See code: [src/commands/package/version/retrieve.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1504
|
+
_See code: [src/commands/package/version/retrieve.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/retrieve.ts)_
|
|
1500
1505
|
|
|
1501
1506
|
## `sf package version update`
|
|
1502
1507
|
|
|
@@ -1549,7 +1554,7 @@ EXAMPLES
|
|
|
1549
1554
|
$ sf package version update --package 04t... --version-description "New Package Version Description"
|
|
1550
1555
|
```
|
|
1551
1556
|
|
|
1552
|
-
_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1557
|
+
_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package/version/update.ts)_
|
|
1553
1558
|
|
|
1554
1559
|
## `sf package1 version create`
|
|
1555
1560
|
|
|
@@ -1616,7 +1621,7 @@ FLAG DESCRIPTIONS
|
|
|
1616
1621
|
subscribers.
|
|
1617
1622
|
```
|
|
1618
1623
|
|
|
1619
|
-
_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1624
|
+
_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package1/version/create.ts)_
|
|
1620
1625
|
|
|
1621
1626
|
## `sf package1 version create get`
|
|
1622
1627
|
|
|
@@ -1649,7 +1654,7 @@ EXAMPLES
|
|
|
1649
1654
|
$ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
|
|
1650
1655
|
```
|
|
1651
1656
|
|
|
1652
|
-
_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1657
|
+
_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package1/version/create/get.ts)_
|
|
1653
1658
|
|
|
1654
1659
|
## `sf package1 version display`
|
|
1655
1660
|
|
|
@@ -1683,7 +1688,7 @@ EXAMPLES
|
|
|
1683
1688
|
$ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
|
|
1684
1689
|
```
|
|
1685
1690
|
|
|
1686
|
-
_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1691
|
+
_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package1/version/display.ts)_
|
|
1687
1692
|
|
|
1688
1693
|
## `sf package1 version list`
|
|
1689
1694
|
|
|
@@ -1721,6 +1726,6 @@ FLAG DESCRIPTIONS
|
|
|
1721
1726
|
If not specified, shows all versions for all packages (managed and unmanaged) in the org.
|
|
1722
1727
|
```
|
|
1723
1728
|
|
|
1724
|
-
_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.
|
|
1729
|
+
_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.3/src/commands/package1/version/list.ts)_
|
|
1725
1730
|
|
|
1726
1731
|
<!-- commandsstop -->
|
|
@@ -1,17 +1,16 @@
|
|
|
1
1
|
# summary
|
|
2
2
|
|
|
3
|
-
Create a package bundle in the Dev Hub org.
|
|
3
|
+
Create a package bundle in the Dev Hub org.
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
A package bundle is an artifact
|
|
8
|
-
A bundle can be installed or upgraded as a single artifact.
|
|
7
|
+
A package bundle is an artifact composed of one or more 2GP managed packages. With a package bundle, you can develop, install, upgrade, and manage multiple packages as a single unit.
|
|
9
8
|
|
|
10
9
|
# examples
|
|
11
10
|
|
|
12
|
-
Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
|
|
11
|
+
- Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
|
|
13
12
|
|
|
14
|
-
|
|
13
|
+
<%= config.bin %> <%= command.id %> --name "Your bundle name" --description "Your bundle description" --target-dev-hub devhub@example.com
|
|
15
14
|
|
|
16
15
|
# flags.name.summary
|
|
17
16
|
|
|
@@ -23,11 +22,11 @@ Description of the package bundle.
|
|
|
23
22
|
|
|
24
23
|
# flags.wait.summary
|
|
25
24
|
|
|
26
|
-
Number of minutes to wait for the bundle
|
|
25
|
+
Number of minutes to wait for the package bundle to be created.
|
|
27
26
|
|
|
28
27
|
# flags.verbose.summary
|
|
29
28
|
|
|
30
|
-
Display extended bundle creation
|
|
29
|
+
Display extended details about the package bundle creation.
|
|
31
30
|
|
|
32
31
|
# requestInProgress
|
|
33
32
|
|
|
@@ -1,28 +1,24 @@
|
|
|
1
1
|
# summary
|
|
2
2
|
|
|
3
|
-
Install a package bundle
|
|
3
|
+
Install a specific version of a package bundle in the target org.
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
During developer preview, package bundles can be installed only in scratch orgs. To install a package bundle in a scratch org, add the PackageBundles feature to the scratch org definition file.
|
|
8
8
|
|
|
9
|
-
# examples
|
|
9
|
+
# examples
|
|
10
10
|
|
|
11
|
-
- Install a package bundle version in a scratch org:
|
|
11
|
+
- Install a package bundle version in a scratch org and wait 10 minutes for the installation to complete:
|
|
12
12
|
|
|
13
|
-
<%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org
|
|
14
|
-
|
|
15
|
-
- Install using a bundle version ID:
|
|
16
|
-
|
|
17
|
-
<%= config.bin %> <%= command.id %> --bundle 1Q8Wt0000000q1pKAA --target-org my-scratch-org --dev-hub-org 00Dxx0000000000 --wait 10
|
|
13
|
+
<%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org devhub@example.com --wait 10
|
|
18
14
|
|
|
19
15
|
# flags.bundle.summary
|
|
20
16
|
|
|
21
|
-
Package bundle version to install
|
|
17
|
+
Package bundle version to install. The valid format is BundleName@VersionNumber, such as "MyPkgBundle@0.1".
|
|
22
18
|
|
|
23
19
|
# flags.target-org.summary
|
|
24
20
|
|
|
25
|
-
|
|
21
|
+
Username or alias of the org in which to install the package bundle version. Not required if the `target-org` configuration variable is already set.
|
|
26
22
|
|
|
27
23
|
# flags.dev-hub-org.summary
|
|
28
24
|
|
|
@@ -30,7 +26,7 @@ Org ID of the Dev Hub org where the bundle was created.
|
|
|
30
26
|
|
|
31
27
|
# flags.dev-hub-org.description
|
|
32
28
|
|
|
33
|
-
|
|
29
|
+
Enter the Dev Hub org ID, such as 00Dxx0000000000.
|
|
34
30
|
|
|
35
31
|
# flags.wait.summary
|
|
36
32
|
|
|
@@ -38,11 +34,11 @@ Number of minutes to wait for the installation to complete.
|
|
|
38
34
|
|
|
39
35
|
# flags.verbose.summary
|
|
40
36
|
|
|
41
|
-
Display extended installation
|
|
37
|
+
Display extended details about the installation.
|
|
42
38
|
|
|
43
39
|
# requestInProgress
|
|
44
40
|
|
|
45
|
-
Installing bundle.
|
|
41
|
+
Installing package bundle.
|
|
46
42
|
|
|
47
43
|
# bundleInstallWaitingStatus
|
|
48
44
|
|
|
@@ -8,7 +8,7 @@ Shows the details of each request to install a package bundle version in the tar
|
|
|
8
8
|
|
|
9
9
|
All filter parameters are applied using the AND logical operator (not OR).
|
|
10
10
|
|
|
11
|
-
To get information about a specific request, run "<%= config.bin %> package bundle install report" and
|
|
11
|
+
To get information about a specific request, run "<%= config.bin %> package bundle install report" and enter the request ID.
|
|
12
12
|
|
|
13
13
|
# flags.status.summary
|
|
14
14
|
|
|
@@ -16,11 +16,11 @@ Status of the installation request, used to filter the list.
|
|
|
16
16
|
|
|
17
17
|
# flags.verbose.summary
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
Display additional information, such as the validation text for each package bundle installation request.
|
|
20
20
|
|
|
21
21
|
# flags.created-last-days.summary
|
|
22
22
|
|
|
23
|
-
Number of days since the request was created, starting at
|
|
23
|
+
Number of days since the request was created, starting at 0. Use 0 for today.
|
|
24
24
|
|
|
25
25
|
# examples
|
|
26
26
|
|
|
@@ -30,17 +30,17 @@ Number of days since the request was created, starting at 00:00:00 of first day
|
|
|
30
30
|
|
|
31
31
|
- List package bundle installation requests from the last 3 days in the Dev Hub org with username devhub@example.com:
|
|
32
32
|
|
|
33
|
-
<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub
|
|
33
|
+
<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub devhub@example.com
|
|
34
34
|
|
|
35
|
-
- List package bundle installation requests with
|
|
35
|
+
- List package bundle installation requests with the Error status:
|
|
36
36
|
|
|
37
37
|
<%= config.bin %> <%= command.id %> --status Error
|
|
38
38
|
|
|
39
|
-
- List package bundle installation requests with
|
|
39
|
+
- List package bundle installation requests with the Queued status:
|
|
40
40
|
|
|
41
41
|
<%= config.bin %> <%= command.id %> --status Queued
|
|
42
42
|
|
|
43
|
-
- List package bundle
|
|
43
|
+
- List package bundle install requests from today with the Success status:
|
|
44
44
|
|
|
45
45
|
<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success
|
|
46
46
|
|
|
@@ -4,21 +4,17 @@ Report on the status of a package bundle installation request.
|
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
The command returns information such as the current status of the request and details about the package bundle version being installed.
|
|
8
8
|
|
|
9
|
-
# examples
|
|
9
|
+
# examples
|
|
10
10
|
|
|
11
11
|
- Report on a package bundle installation request:
|
|
12
12
|
|
|
13
13
|
<%= config.bin %> <%= command.id %> --package-install-request-id 0Ho0x0000000000000
|
|
14
14
|
|
|
15
|
-
- Report on a package bundle installation request using an alias:
|
|
16
|
-
|
|
17
|
-
<%= config.bin %> force:package:bundle:install:report -i 0Ho0x0000000000000
|
|
18
|
-
|
|
19
15
|
# flags.package-install-request-id.summary
|
|
20
16
|
|
|
21
|
-
|
|
17
|
+
ID of the package bundle installation request to report on.
|
|
22
18
|
|
|
23
19
|
# id
|
|
24
20
|
|
|
@@ -38,9 +34,9 @@ Development Organization
|
|
|
38
34
|
|
|
39
35
|
# validation-error
|
|
40
36
|
|
|
41
|
-
Validation Error
|
|
37
|
+
Validation Error
|
|
42
38
|
|
|
43
|
-
# created-date
|
|
39
|
+
# created-date
|
|
44
40
|
|
|
45
41
|
Created Date
|
|
46
42
|
|
package/messages/bundle_list.md
CHANGED
|
@@ -4,13 +4,13 @@ List all package bundles in the Dev Hub org.
|
|
|
4
4
|
|
|
5
5
|
# examples
|
|
6
6
|
|
|
7
|
-
List all package bundles in the
|
|
7
|
+
- List all package bundles in the Dev Hub org with the username `devhub@example.com`:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com
|
|
10
10
|
|
|
11
|
-
# namespace
|
|
11
|
+
# namespace
|
|
12
12
|
|
|
13
|
-
Namespace Prefix
|
|
13
|
+
Namespace Prefix
|
|
14
14
|
|
|
15
15
|
# name
|
|
16
16
|
|
|
@@ -18,15 +18,15 @@ Name
|
|
|
18
18
|
|
|
19
19
|
# id
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
ID
|
|
22
22
|
|
|
23
23
|
# bundle-id
|
|
24
24
|
|
|
25
|
-
Package Bundle
|
|
25
|
+
Package Bundle ID
|
|
26
26
|
|
|
27
27
|
# alias
|
|
28
28
|
|
|
29
|
-
Alias
|
|
29
|
+
Alias
|
|
30
30
|
|
|
31
31
|
# description
|
|
32
32
|
|
|
@@ -34,7 +34,7 @@ Description
|
|
|
34
34
|
|
|
35
35
|
# flags.verbose.summary
|
|
36
36
|
|
|
37
|
-
Display extended
|
|
37
|
+
Display extended details about the package bundles.
|
|
38
38
|
|
|
39
39
|
# error-notification-username
|
|
40
40
|
|
|
@@ -42,4 +42,4 @@ Error Notification Username
|
|
|
42
42
|
|
|
43
43
|
# createdBy
|
|
44
44
|
|
|
45
|
-
Created By
|
|
45
|
+
Created By
|
|
@@ -4,25 +4,29 @@ Create a new package bundle version.
|
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Before you create a new bundle version, create a definition file (similar to a scratch org definition file) that contains the list of package versions to include in the bundle. The definition file must be JSON and you must specify the package versions in the correct order of installation. The package bundle version is based on package versions listed in the definition file.
|
|
8
8
|
|
|
9
|
+
After the first bundle version that you create, make sure to update the version number in the sfdx-project.json file for subsequent bundle versions.
|
|
10
|
+
|
|
11
|
+
To retrieve details about a package bundle version create request, including status and package bundle version ID (04t), run "sf package version create report -i 08c...".
|
|
12
|
+
|
|
9
13
|
# examples
|
|
10
14
|
|
|
11
|
-
Create a
|
|
15
|
+
- Create a package bundle version in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
|
|
12
16
|
|
|
13
|
-
|
|
17
|
+
<%= config.bin %> <%= command.id %> --bundle “Your bundle name” --definition-file resources/definition.json --target-dev-hub devhub@example.com
|
|
14
18
|
|
|
15
19
|
# flags.bundle.summary
|
|
16
20
|
|
|
17
|
-
|
|
21
|
+
Name or ID of the package bundle to create a version for.
|
|
18
22
|
|
|
19
23
|
# flags.definition-file.summary
|
|
20
24
|
|
|
21
|
-
Path to
|
|
25
|
+
Path to a definition file, similar to a scratch org definition file, that contains the list of package versions to include in the bundle.
|
|
22
26
|
|
|
23
27
|
# flags.wait.summary
|
|
24
28
|
|
|
25
|
-
Number of minutes to wait for the
|
|
29
|
+
Number of minutes to wait for the package bundle version to be created.
|
|
26
30
|
|
|
27
31
|
# flags.verbose.summary
|
|
28
32
|
|
|
@@ -46,24 +50,24 @@ Waiting for bundle version creation to complete. %s minutes remaining. Current s
|
|
|
46
50
|
|
|
47
51
|
# bundleVersionCreateFinalStatus
|
|
48
52
|
|
|
49
|
-
Package
|
|
53
|
+
Package bundle version creation completed with status: %s
|
|
50
54
|
|
|
51
55
|
# multipleErrors
|
|
52
56
|
|
|
53
|
-
The following errors occurred during bundle version creation:
|
|
57
|
+
The following errors occurred during package bundle version creation:
|
|
54
58
|
%s
|
|
55
59
|
|
|
56
60
|
# InProgress
|
|
57
61
|
|
|
58
|
-
|
|
62
|
+
Package bundle version creation is %s. Use "sf package bundle version create report -i %s" to check the status later.
|
|
59
63
|
|
|
60
64
|
# requestInProgress
|
|
61
65
|
|
|
62
|
-
Creating bundle version...
|
|
66
|
+
Creating package bundle version...
|
|
63
67
|
|
|
64
68
|
# packageVersionCreateFinalStatus
|
|
65
69
|
|
|
66
|
-
Package
|
|
70
|
+
Package bundle version creation completed with status: %s
|
|
67
71
|
|
|
68
72
|
# packageVersionCreatePerformingValidations
|
|
69
73
|
|
|
@@ -71,4 +75,4 @@ Performing validations on the package bundle version...
|
|
|
71
75
|
|
|
72
76
|
# bundleVersionCreateSuccess
|
|
73
77
|
|
|
74
|
-
Successfully created bundle version for bundle %s
|
|
78
|
+
Successfully created package bundle version for bundle %s
|
|
@@ -8,23 +8,23 @@ Shows the details of each request to create a package bundle version in the Dev
|
|
|
8
8
|
|
|
9
9
|
All filter parameters are applied using the AND logical operator (not OR).
|
|
10
10
|
|
|
11
|
-
To get information about a specific request, run "<%= config.bin %> package bundle version create report" and
|
|
11
|
+
To get information about a specific request, run "<%= config.bin %> package bundle version create report" and enter the request ID.
|
|
12
12
|
|
|
13
13
|
# flags.status.summary
|
|
14
14
|
|
|
15
|
-
Status of the
|
|
15
|
+
Status of the installation request, used to filter the list.
|
|
16
16
|
|
|
17
17
|
# flags.show-conversions-only.summary
|
|
18
18
|
|
|
19
|
-
Filter the list
|
|
19
|
+
Filter the list to display only converted package bundle versions.
|
|
20
20
|
|
|
21
21
|
# flags.verbose.summary
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
Display additional information, such as the version name and number for each package bundle version creation request.
|
|
24
24
|
|
|
25
25
|
# flags.created-last-days.summary
|
|
26
26
|
|
|
27
|
-
Number of days since the request was created, starting at
|
|
27
|
+
Number of days since the request was created, starting at 0. Use 0 for today.
|
|
28
28
|
|
|
29
29
|
# examples
|
|
30
30
|
|
|
@@ -32,19 +32,19 @@ Number of days since the request was created, starting at 00:00:00 of first day
|
|
|
32
32
|
|
|
33
33
|
<%= config.bin %> <%= command.id %>
|
|
34
34
|
|
|
35
|
-
- List package bundle version creation requests from the last
|
|
35
|
+
- List package bundle version creation requests from the last three days in the Dev Hub org with the username devhub@example.com:
|
|
36
36
|
|
|
37
|
-
<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub
|
|
37
|
+
<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub devhub@example.com
|
|
38
38
|
|
|
39
|
-
- List package bundle version creation requests with
|
|
39
|
+
- List package bundle version creation requests with the Error status:
|
|
40
40
|
|
|
41
41
|
<%= config.bin %> <%= command.id %> --status Error
|
|
42
42
|
|
|
43
|
-
- List package bundle version creation requests with
|
|
43
|
+
- List package bundle version creation requests with the Queued status:
|
|
44
44
|
|
|
45
45
|
<%= config.bin %> <%= command.id %> --status Queued
|
|
46
46
|
|
|
47
|
-
- List package bundle version creation requests with
|
|
47
|
+
- List package bundle version creation requests from today with the Success status:
|
|
48
48
|
|
|
49
49
|
<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success
|
|
50
50
|
|
|
@@ -58,11 +58,11 @@ Status
|
|
|
58
58
|
|
|
59
59
|
# package-id
|
|
60
60
|
|
|
61
|
-
Package Bundle
|
|
61
|
+
Package Bundle ID
|
|
62
62
|
|
|
63
63
|
# packageVersionId
|
|
64
64
|
|
|
65
|
-
Package Bundle Version
|
|
65
|
+
Package Bundle Version ID
|
|
66
66
|
|
|
67
67
|
# createdBy
|
|
68
68
|
|
|
@@ -70,4 +70,4 @@ Created By
|
|
|
70
70
|
|
|
71
71
|
# convertedFromVersionId
|
|
72
72
|
|
|
73
|
-
Converted From Version
|
|
73
|
+
Converted From Version ID
|
|
@@ -4,21 +4,17 @@ Report on the status of a package bundle version creation request.
|
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
The command returns information such as the request's current status and details about the package bundle version being created.
|
|
8
8
|
|
|
9
|
-
# examples
|
|
9
|
+
# examples
|
|
10
10
|
|
|
11
11
|
- Report on a package bundle version creation request:
|
|
12
12
|
|
|
13
13
|
<%= config.bin %> <%= command.id %> --package-create-request-id 0Ho0x0000000000000
|
|
14
14
|
|
|
15
|
-
- Report on a package bundle version creation request using an alias:
|
|
16
|
-
|
|
17
|
-
<%= config.bin %> force:package:bundle:version:create:report -i 0Ho0x0000000000000
|
|
18
|
-
|
|
19
15
|
# flags.bundle-version-create-request-id.summary
|
|
20
16
|
|
|
21
|
-
|
|
17
|
+
ID of the package bundle version creation request to report on.
|
|
22
18
|
|
|
23
19
|
# id
|
|
24
20
|
|
|
@@ -36,11 +32,11 @@ Package Bundle ID
|
|
|
36
32
|
|
|
37
33
|
Package Bundle Version ID
|
|
38
34
|
|
|
39
|
-
# version-name
|
|
35
|
+
# version-name
|
|
40
36
|
|
|
41
37
|
Version Name
|
|
42
38
|
|
|
43
|
-
# created-date
|
|
39
|
+
# created-date
|
|
44
40
|
|
|
45
41
|
Created Date
|
|
46
42
|
|
|
@@ -4,9 +4,9 @@ List all package bundle versions in the Dev Hub org.
|
|
|
4
4
|
|
|
5
5
|
# examples
|
|
6
6
|
|
|
7
|
-
List package bundle versions in the Dev Hub org with the username devhub@example.com:
|
|
7
|
+
- List package bundle versions in the Dev Hub org with the username devhub@example.com:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com
|
|
10
10
|
|
|
11
11
|
# namespace
|
|
12
12
|
|
|
@@ -15,14 +15,14 @@ Namespace Prefix
|
|
|
15
15
|
# name
|
|
16
16
|
|
|
17
17
|
Name
|
|
18
|
-
|
|
18
|
+
|
|
19
19
|
# id
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
ID
|
|
22
22
|
|
|
23
23
|
# bundle-id
|
|
24
24
|
|
|
25
|
-
Package Bundle
|
|
25
|
+
Package Bundle ID
|
|
26
26
|
|
|
27
27
|
# alias
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Description
|
|
|
34
34
|
|
|
35
35
|
# flags.verbose.summary
|
|
36
36
|
|
|
37
|
-
Display extended bundle
|
|
37
|
+
Display extended details about the package bundle versions.
|
|
38
38
|
|
|
39
39
|
# error-notification-username
|
|
40
40
|
|
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
# summary
|
|
2
2
|
|
|
3
|
-
Retrieve details about a package bundle version
|
|
3
|
+
Retrieve details about a specific package bundle version.
|
|
4
4
|
|
|
5
5
|
# examples
|
|
6
6
|
|
|
7
|
-
Retrieve details about the package bundle version; uses the Dev Hub org with the username devhub@example.com:
|
|
7
|
+
- Retrieve details about the package bundle version; uses the Dev Hub org with the username devhub@example.com:
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
<%= config.bin %> <%= command.id %> --bundle-version "Your bundle version name or ID" --target-dev-hub devhub@example.com
|
|
10
10
|
|
|
11
11
|
# flags.bundle-version.summary
|
|
12
12
|
|
|
13
|
-
ID of the package bundle version to retrieve details
|
|
13
|
+
Name or ID of the package bundle version to retrieve details about.
|
|
14
14
|
|
|
15
15
|
# flags.verbose.summary
|
|
16
16
|
|
|
17
|
-
Display extended package bundle version
|
|
17
|
+
Display extended details about the package bundle version.
|
|
@@ -4,9 +4,7 @@ Delete a package bundle.
|
|
|
4
4
|
|
|
5
5
|
# description
|
|
6
6
|
|
|
7
|
-
Specify the ID or alias of the package bundle you want to delete.
|
|
8
|
-
|
|
9
|
-
Delete package bundles. Before you delete a package bundle, first delete all associated package bundle versions.
|
|
7
|
+
Specify the ID or alias of the package bundle you want to delete. Before you delete a package bundle, first delete all associated package bundle versions.
|
|
10
8
|
|
|
11
9
|
# examples
|
|
12
10
|
|
|
@@ -34,7 +32,7 @@ Do you want to continue? (y/n)
|
|
|
34
32
|
|
|
35
33
|
# prompt-delete-deny
|
|
36
34
|
|
|
37
|
-
The request to delete this package bundle was canceled
|
|
35
|
+
The request to delete this package bundle was canceled.
|
|
38
36
|
|
|
39
37
|
# humanSuccess
|
|
40
38
|
|
|
@@ -40,11 +40,12 @@ Successfully updated the package. %s
|
|
|
40
40
|
|
|
41
41
|
# flags.recommended-version-id.summary
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
ID of the package version that's installed when subscribers click the Upgrade to Recommended Version option on the Installed Package page of their org.
|
|
44
44
|
|
|
45
45
|
# flags.recommended-version-id.description
|
|
46
46
|
|
|
47
|
-
Specify the recommended package version for subscribers to install.
|
|
47
|
+
Specify the recommended package version for subscribers to install. If a subscriber has a package version installed in their org that's lower than the version you set, the subscriber sees the Upgrade to Recommended Version option on the Installed Package page. Only released package versions can be set as the recommended version.
|
|
48
|
+
|
|
48
49
|
|
|
49
50
|
# flags.skip-ancestor-check.summary
|
|
50
51
|
|
package/oclif.manifest.json
CHANGED
|
@@ -1025,9 +1025,9 @@
|
|
|
1025
1025
|
},
|
|
1026
1026
|
"recommended-version-id": {
|
|
1027
1027
|
"char": "r",
|
|
1028
|
-
"description": "Specify the recommended package version for subscribers to install.
|
|
1028
|
+
"description": "Specify the recommended package version for subscribers to install. If a subscriber has a package version installed in their org that's lower than the version you set, the subscriber sees the Upgrade to Recommended Version option on the Installed Package page. Only released package versions can be set as the recommended version.",
|
|
1029
1029
|
"name": "recommended-version-id",
|
|
1030
|
-
"summary": "
|
|
1030
|
+
"summary": "ID of the package version that's installed when subscribers click the Upgrade to Recommended Version option on the Installed Package page of their org.",
|
|
1031
1031
|
"hasDynamicHelp": false,
|
|
1032
1032
|
"multiple": false,
|
|
1033
1033
|
"type": "option"
|
|
@@ -1071,9 +1071,9 @@
|
|
|
1071
1071
|
"package:bundle:create": {
|
|
1072
1072
|
"aliases": [],
|
|
1073
1073
|
"args": {},
|
|
1074
|
-
"description": "A package bundle is an artifact
|
|
1074
|
+
"description": "A package bundle is an artifact composed of one or more 2GP managed packages. With a package bundle, you can develop, install, upgrade, and manage multiple packages as a single unit.",
|
|
1075
1075
|
"examples": [
|
|
1076
|
-
"Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:\n
|
|
1076
|
+
"Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --name \"Your bundle name\" --description \"Your bundle description\" --target-dev-hub devhub@example.com"
|
|
1077
1077
|
],
|
|
1078
1078
|
"flags": {
|
|
1079
1079
|
"json": {
|
|
@@ -1178,7 +1178,7 @@
|
|
|
1178
1178
|
"package:bundle:delete": {
|
|
1179
1179
|
"aliases": [],
|
|
1180
1180
|
"args": {},
|
|
1181
|
-
"description": "Specify the ID or alias of the package bundle you want to delete
|
|
1181
|
+
"description": "Specify the ID or alias of the package bundle you want to delete. Before you delete a package bundle, first delete all associated package bundle versions.",
|
|
1182
1182
|
"examples": [
|
|
1183
1183
|
"Delete a package bundle using its alias from your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --bundle \"Your Bundle Alias\"",
|
|
1184
1184
|
"Delete a package bundle using its ID from the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --bundle 1Fl... --target-dev-hub devhub@example.com"
|
|
@@ -1285,10 +1285,9 @@
|
|
|
1285
1285
|
"package:bundle:install": {
|
|
1286
1286
|
"aliases": [],
|
|
1287
1287
|
"args": {},
|
|
1288
|
-
"description": "
|
|
1288
|
+
"description": "During developer preview, package bundles can be installed only in scratch orgs. To install a package bundle in a scratch org, add the PackageBundles feature to the scratch org definition file.",
|
|
1289
1289
|
"examples": [
|
|
1290
|
-
"Install a package bundle version in a scratch org:\n<%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org
|
|
1291
|
-
"Install using a bundle version ID:\n<%= config.bin %> <%= command.id %> --bundle 1Q8Wt0000000q1pKAA --target-org my-scratch-org --dev-hub-org 00Dxx0000000000 --wait 10"
|
|
1290
|
+
"Install a package bundle version in a scratch org and wait 10 minutes for the installation to complete:\n<%= config.bin %> <%= command.id %> --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --dev-hub-org devhub@example.com --wait 10"
|
|
1292
1291
|
],
|
|
1293
1292
|
"flags": {
|
|
1294
1293
|
"json": {
|
|
@@ -1320,7 +1319,7 @@
|
|
|
1320
1319
|
"char": "b",
|
|
1321
1320
|
"name": "bundle",
|
|
1322
1321
|
"required": true,
|
|
1323
|
-
"summary": "Package bundle version to install
|
|
1322
|
+
"summary": "Package bundle version to install. The valid format is BundleName@VersionNumber, such as \"MyPkgBundle@0.1\".",
|
|
1324
1323
|
"hasDynamicHelp": false,
|
|
1325
1324
|
"multiple": false,
|
|
1326
1325
|
"type": "option"
|
|
@@ -1353,7 +1352,7 @@
|
|
|
1353
1352
|
},
|
|
1354
1353
|
"dev-hub-org": {
|
|
1355
1354
|
"char": "d",
|
|
1356
|
-
"description": "
|
|
1355
|
+
"description": "Enter the Dev Hub org ID, such as 00Dxx0000000000.",
|
|
1357
1356
|
"name": "dev-hub-org",
|
|
1358
1357
|
"required": true,
|
|
1359
1358
|
"summary": "Org ID of the Dev Hub org where the bundle was created.",
|
|
@@ -1372,7 +1371,7 @@
|
|
|
1372
1371
|
},
|
|
1373
1372
|
"verbose": {
|
|
1374
1373
|
"name": "verbose",
|
|
1375
|
-
"summary": "Display extended installation
|
|
1374
|
+
"summary": "Display extended details about the installation.",
|
|
1376
1375
|
"allowNo": false,
|
|
1377
1376
|
"type": "boolean"
|
|
1378
1377
|
}
|
|
@@ -1386,7 +1385,7 @@
|
|
|
1386
1385
|
"pluginType": "core",
|
|
1387
1386
|
"state": "beta",
|
|
1388
1387
|
"strict": true,
|
|
1389
|
-
"summary": "Install a package bundle
|
|
1388
|
+
"summary": "Install a specific version of a package bundle in the target org.",
|
|
1390
1389
|
"enableJsonFlag": true,
|
|
1391
1390
|
"requiresProject": true,
|
|
1392
1391
|
"isESM": true,
|
|
@@ -1411,7 +1410,7 @@
|
|
|
1411
1410
|
"aliases": [],
|
|
1412
1411
|
"args": {},
|
|
1413
1412
|
"examples": [
|
|
1414
|
-
"List all package bundles in the
|
|
1413
|
+
"List all package bundles in the Dev Hub org with the username `devhub@example.com`:\n<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com"
|
|
1415
1414
|
],
|
|
1416
1415
|
"flags": {
|
|
1417
1416
|
"json": {
|
|
@@ -1467,7 +1466,7 @@
|
|
|
1467
1466
|
},
|
|
1468
1467
|
"verbose": {
|
|
1469
1468
|
"name": "verbose",
|
|
1470
|
-
"summary": "Display extended
|
|
1469
|
+
"summary": "Display extended details about the package bundles.",
|
|
1471
1470
|
"allowNo": false,
|
|
1472
1471
|
"type": "boolean"
|
|
1473
1472
|
}
|
|
@@ -4357,13 +4356,13 @@
|
|
|
4357
4356
|
"package:bundle:install:list": {
|
|
4358
4357
|
"aliases": [],
|
|
4359
4358
|
"args": {},
|
|
4360
|
-
"description": "Shows the details of each request to install a package bundle version in the target org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"<%= config.bin %> package bundle install report\" and
|
|
4359
|
+
"description": "Shows the details of each request to install a package bundle version in the target org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"<%= config.bin %> package bundle install report\" and enter the request ID.",
|
|
4361
4360
|
"examples": [
|
|
4362
4361
|
"List all package bundle installation requests in your default Dev Hub org:\n<%= config.bin %> <%= command.id %>",
|
|
4363
|
-
"List package bundle installation requests from the last 3 days in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub",
|
|
4364
|
-
"List package bundle installation requests with
|
|
4365
|
-
"List package bundle installation requests with
|
|
4366
|
-
"List package bundle
|
|
4362
|
+
"List package bundle installation requests from the last 3 days in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub devhub@example.com",
|
|
4363
|
+
"List package bundle installation requests with the Error status:\n<%= config.bin %> <%= command.id %> --status Error",
|
|
4364
|
+
"List package bundle installation requests with the Queued status:\n<%= config.bin %> <%= command.id %> --status Queued",
|
|
4365
|
+
"List package bundle install requests from today with the Success status:\n<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success"
|
|
4367
4366
|
],
|
|
4368
4367
|
"flags": {
|
|
4369
4368
|
"json": {
|
|
@@ -4420,7 +4419,7 @@
|
|
|
4420
4419
|
"created-last-days": {
|
|
4421
4420
|
"char": "c",
|
|
4422
4421
|
"name": "created-last-days",
|
|
4423
|
-
"summary": "Number of days since the request was created, starting at
|
|
4422
|
+
"summary": "Number of days since the request was created, starting at 0. Use 0 for today.",
|
|
4424
4423
|
"hasDynamicHelp": false,
|
|
4425
4424
|
"multiple": false,
|
|
4426
4425
|
"type": "option"
|
|
@@ -4441,7 +4440,7 @@
|
|
|
4441
4440
|
},
|
|
4442
4441
|
"verbose": {
|
|
4443
4442
|
"name": "verbose",
|
|
4444
|
-
"summary": "
|
|
4443
|
+
"summary": "Display additional information, such as the validation text for each package bundle installation request.",
|
|
4445
4444
|
"allowNo": false,
|
|
4446
4445
|
"type": "boolean"
|
|
4447
4446
|
}
|
|
@@ -4497,10 +4496,9 @@
|
|
|
4497
4496
|
"package:bundle:install:report": {
|
|
4498
4497
|
"aliases": [],
|
|
4499
4498
|
"args": {},
|
|
4500
|
-
"description": "
|
|
4499
|
+
"description": "The command returns information such as the current status of the request and details about the package bundle version being installed.",
|
|
4501
4500
|
"examples": [
|
|
4502
|
-
"Report on a package bundle installation request:\n<%= config.bin %> <%= command.id %> --package-install-request-id 0Ho0x0000000000000"
|
|
4503
|
-
"Report on a package bundle installation request using an alias:\n<%= config.bin %> force:package:bundle:install:report -i 0Ho0x0000000000000"
|
|
4501
|
+
"Report on a package bundle installation request:\n<%= config.bin %> <%= command.id %> --package-install-request-id 0Ho0x0000000000000"
|
|
4504
4502
|
],
|
|
4505
4503
|
"flags": {
|
|
4506
4504
|
"json": {
|
|
@@ -4558,7 +4556,7 @@
|
|
|
4558
4556
|
"char": "i",
|
|
4559
4557
|
"name": "package-install-request-id",
|
|
4560
4558
|
"required": true,
|
|
4561
|
-
"summary": "
|
|
4559
|
+
"summary": "ID of the package bundle installation request to report on.",
|
|
4562
4560
|
"hasDynamicHelp": false,
|
|
4563
4561
|
"multiple": false,
|
|
4564
4562
|
"type": "option"
|
|
@@ -4622,9 +4620,9 @@
|
|
|
4622
4620
|
"package:bundle:version:create": {
|
|
4623
4621
|
"aliases": [],
|
|
4624
4622
|
"args": {},
|
|
4625
|
-
"description": "
|
|
4623
|
+
"description": "Before you create a new bundle version, create a definition file (similar to a scratch org definition file) that contains the list of package versions to include in the bundle. The definition file must be JSON and you must specify the package versions in the correct order of installation. The package bundle version is based on package versions listed in the definition file.\n\nAfter the first bundle version that you create, make sure to update the version number in the sfdx-project.json file for subsequent bundle versions.\n\nTo retrieve details about a package bundle version create request, including status and package bundle version ID (04t), run \"sf package version create report -i 08c...\".",
|
|
4626
4624
|
"examples": [
|
|
4627
|
-
"Create a
|
|
4625
|
+
"Create a package bundle version in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --bundle “Your bundle name” --definition-file resources/definition.json --target-dev-hub devhub@example.com"
|
|
4628
4626
|
],
|
|
4629
4627
|
"flags": {
|
|
4630
4628
|
"json": {
|
|
@@ -4656,7 +4654,7 @@
|
|
|
4656
4654
|
"char": "b",
|
|
4657
4655
|
"name": "bundle",
|
|
4658
4656
|
"required": true,
|
|
4659
|
-
"summary": "
|
|
4657
|
+
"summary": "Name or ID of the package bundle to create a version for.",
|
|
4660
4658
|
"hasDynamicHelp": false,
|
|
4661
4659
|
"multiple": false,
|
|
4662
4660
|
"type": "option"
|
|
@@ -4673,7 +4671,7 @@
|
|
|
4673
4671
|
"char": "p",
|
|
4674
4672
|
"name": "definition-file",
|
|
4675
4673
|
"required": true,
|
|
4676
|
-
"summary": "Path to
|
|
4674
|
+
"summary": "Path to a definition file, similar to a scratch org definition file, that contains the list of package versions to include in the bundle.",
|
|
4677
4675
|
"hasDynamicHelp": false,
|
|
4678
4676
|
"multiple": false,
|
|
4679
4677
|
"type": "option"
|
|
@@ -4707,7 +4705,7 @@
|
|
|
4707
4705
|
"wait": {
|
|
4708
4706
|
"char": "w",
|
|
4709
4707
|
"name": "wait",
|
|
4710
|
-
"summary": "Number of minutes to wait for the
|
|
4708
|
+
"summary": "Number of minutes to wait for the package bundle version to be created.",
|
|
4711
4709
|
"default": 0,
|
|
4712
4710
|
"hasDynamicHelp": false,
|
|
4713
4711
|
"multiple": false,
|
|
@@ -4782,7 +4780,7 @@
|
|
|
4782
4780
|
"args": {},
|
|
4783
4781
|
"description": "Description",
|
|
4784
4782
|
"examples": [
|
|
4785
|
-
"List package bundle versions in the Dev Hub org with the username devhub@example.com:\n
|
|
4783
|
+
"List package bundle versions in the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --target-dev-hub devhub@example.com"
|
|
4786
4784
|
],
|
|
4787
4785
|
"flags": {
|
|
4788
4786
|
"json": {
|
|
@@ -4838,7 +4836,7 @@
|
|
|
4838
4836
|
},
|
|
4839
4837
|
"verbose": {
|
|
4840
4838
|
"name": "verbose",
|
|
4841
|
-
"summary": "Display extended bundle
|
|
4839
|
+
"summary": "Display extended details about the package bundle versions.",
|
|
4842
4840
|
"allowNo": false,
|
|
4843
4841
|
"type": "boolean"
|
|
4844
4842
|
}
|
|
@@ -4895,7 +4893,7 @@
|
|
|
4895
4893
|
"aliases": [],
|
|
4896
4894
|
"args": {},
|
|
4897
4895
|
"examples": [
|
|
4898
|
-
"Retrieve details about the package bundle version; uses the Dev Hub org with the username devhub@example.com:\n
|
|
4896
|
+
"Retrieve details about the package bundle version; uses the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --bundle-version \"Your bundle version name or ID\" --target-dev-hub devhub@example.com"
|
|
4899
4897
|
],
|
|
4900
4898
|
"flags": {
|
|
4901
4899
|
"json": {
|
|
@@ -4953,14 +4951,14 @@
|
|
|
4953
4951
|
"char": "b",
|
|
4954
4952
|
"name": "bundle-version",
|
|
4955
4953
|
"required": true,
|
|
4956
|
-
"summary": "ID of the package bundle version to retrieve details
|
|
4954
|
+
"summary": "Name or ID of the package bundle version to retrieve details about.",
|
|
4957
4955
|
"hasDynamicHelp": false,
|
|
4958
4956
|
"multiple": false,
|
|
4959
4957
|
"type": "option"
|
|
4960
4958
|
},
|
|
4961
4959
|
"verbose": {
|
|
4962
4960
|
"name": "verbose",
|
|
4963
|
-
"summary": "Display extended package bundle version
|
|
4961
|
+
"summary": "Display extended details about the package bundle version.",
|
|
4964
4962
|
"allowNo": false,
|
|
4965
4963
|
"type": "boolean"
|
|
4966
4964
|
}
|
|
@@ -4974,7 +4972,7 @@
|
|
|
4974
4972
|
"pluginType": "core",
|
|
4975
4973
|
"state": "beta",
|
|
4976
4974
|
"strict": true,
|
|
4977
|
-
"summary": "Retrieve details about a package bundle version
|
|
4975
|
+
"summary": "Retrieve details about a specific package bundle version.",
|
|
4978
4976
|
"enableJsonFlag": true,
|
|
4979
4977
|
"isESM": true,
|
|
4980
4978
|
"relativePath": [
|
|
@@ -5775,13 +5773,13 @@
|
|
|
5775
5773
|
"package:bundle:version:create:list": {
|
|
5776
5774
|
"aliases": [],
|
|
5777
5775
|
"args": {},
|
|
5778
|
-
"description": "Shows the details of each request to create a package bundle version in the Dev Hub org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"<%= config.bin %> package bundle version create report\" and
|
|
5776
|
+
"description": "Shows the details of each request to create a package bundle version in the Dev Hub org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"<%= config.bin %> package bundle version create report\" and enter the request ID.",
|
|
5779
5777
|
"examples": [
|
|
5780
5778
|
"List all package bundle version creation requests in your default Dev Hub org:\n<%= config.bin %> <%= command.id %>",
|
|
5781
|
-
"List package bundle version creation requests from the last
|
|
5782
|
-
"List package bundle version creation requests with
|
|
5783
|
-
"List package bundle version creation requests with
|
|
5784
|
-
"List package bundle version creation requests with
|
|
5779
|
+
"List package bundle version creation requests from the last three days in the Dev Hub org with the username devhub@example.com:\n<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub devhub@example.com",
|
|
5780
|
+
"List package bundle version creation requests with the Error status:\n<%= config.bin %> <%= command.id %> --status Error",
|
|
5781
|
+
"List package bundle version creation requests with the Queued status:\n<%= config.bin %> <%= command.id %> --status Queued",
|
|
5782
|
+
"List package bundle version creation requests from today with the Success status:\n<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success"
|
|
5785
5783
|
],
|
|
5786
5784
|
"flags": {
|
|
5787
5785
|
"json": {
|
|
@@ -5838,7 +5836,7 @@
|
|
|
5838
5836
|
"created-last-days": {
|
|
5839
5837
|
"char": "c",
|
|
5840
5838
|
"name": "created-last-days",
|
|
5841
|
-
"summary": "Number of days since the request was created, starting at
|
|
5839
|
+
"summary": "Number of days since the request was created, starting at 0. Use 0 for today.",
|
|
5842
5840
|
"hasDynamicHelp": false,
|
|
5843
5841
|
"multiple": false,
|
|
5844
5842
|
"type": "option"
|
|
@@ -5846,7 +5844,7 @@
|
|
|
5846
5844
|
"status": {
|
|
5847
5845
|
"char": "s",
|
|
5848
5846
|
"name": "status",
|
|
5849
|
-
"summary": "Status of the
|
|
5847
|
+
"summary": "Status of the installation request, used to filter the list.",
|
|
5850
5848
|
"hasDynamicHelp": false,
|
|
5851
5849
|
"multiple": false,
|
|
5852
5850
|
"options": [
|
|
@@ -5859,13 +5857,13 @@
|
|
|
5859
5857
|
},
|
|
5860
5858
|
"show-conversions-only": {
|
|
5861
5859
|
"name": "show-conversions-only",
|
|
5862
|
-
"summary": "Filter the list
|
|
5860
|
+
"summary": "Filter the list to display only converted package bundle versions.",
|
|
5863
5861
|
"allowNo": false,
|
|
5864
5862
|
"type": "boolean"
|
|
5865
5863
|
},
|
|
5866
5864
|
"verbose": {
|
|
5867
5865
|
"name": "verbose",
|
|
5868
|
-
"summary": "
|
|
5866
|
+
"summary": "Display additional information, such as the version name and number for each package bundle version creation request.",
|
|
5869
5867
|
"allowNo": false,
|
|
5870
5868
|
"type": "boolean"
|
|
5871
5869
|
}
|
|
@@ -6018,10 +6016,9 @@
|
|
|
6018
6016
|
"package:bundle:version:create:report": {
|
|
6019
6017
|
"aliases": [],
|
|
6020
6018
|
"args": {},
|
|
6021
|
-
"description": "
|
|
6019
|
+
"description": "The command returns information such as the request's current status and details about the package bundle version being created.",
|
|
6022
6020
|
"examples": [
|
|
6023
|
-
"Report on a package bundle version creation request:\n<%= config.bin %> <%= command.id %> --package-create-request-id 0Ho0x0000000000000"
|
|
6024
|
-
"Report on a package bundle version creation request using an alias:\n<%= config.bin %> force:package:bundle:version:create:report -i 0Ho0x0000000000000"
|
|
6021
|
+
"Report on a package bundle version creation request:\n<%= config.bin %> <%= command.id %> --package-create-request-id 0Ho0x0000000000000"
|
|
6025
6022
|
],
|
|
6026
6023
|
"flags": {
|
|
6027
6024
|
"json": {
|
|
@@ -6079,7 +6076,7 @@
|
|
|
6079
6076
|
"char": "i",
|
|
6080
6077
|
"name": "bundle-version-create-request-id",
|
|
6081
6078
|
"required": true,
|
|
6082
|
-
"summary": "
|
|
6079
|
+
"summary": "ID of the package bundle version creation request to report on.",
|
|
6083
6080
|
"hasDynamicHelp": false,
|
|
6084
6081
|
"multiple": false,
|
|
6085
6082
|
"type": "option"
|
|
@@ -6231,5 +6228,5 @@
|
|
|
6231
6228
|
]
|
|
6232
6229
|
}
|
|
6233
6230
|
},
|
|
6234
|
-
"version": "2.24.
|
|
6231
|
+
"version": "2.24.3"
|
|
6235
6232
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/plugin-packaging",
|
|
3
3
|
"description": "SF plugin that support Salesforce Packaging Platform",
|
|
4
|
-
"version": "2.24.
|
|
4
|
+
"version": "2.24.3",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bugs": "https://github.com/forcedotcom/cli/issues",
|
|
7
7
|
"dependencies": {
|
|
@@ -248,7 +248,7 @@
|
|
|
248
248
|
"exports": "./lib/index.js",
|
|
249
249
|
"type": "module",
|
|
250
250
|
"sfdx": {
|
|
251
|
-
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/2.24.
|
|
252
|
-
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/2.24.
|
|
251
|
+
"publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/2.24.3.crt",
|
|
252
|
+
"signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/2.24.3.sig"
|
|
253
253
|
}
|
|
254
254
|
}
|