@salesforce/plugin-packaging 2.24.1 → 2.24.2

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
@@ -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.1/src/commands/package/convert.ts)_
158
+ _See code: [src/commands/package/convert.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/create.ts)_
237
+ _See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/delete.ts)_
279
+ _See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/install.ts)_
378
+ _See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/install/report.ts)_
411
+ _See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/installed/list.ts)_
443
+ _See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/list.ts)_
481
+ _See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/push-upgrade/abort.ts)_
520
+ _See code: [src/commands/package/push-upgrade/abort.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/push-upgrade/list.ts)_
579
+ _See code: [src/commands/package/push-upgrade/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/push-upgrade/report.ts)_
621
+ _See code: [src/commands/package/push-upgrade/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/push-upgrade/schedule.ts)_
708
+ _See code: [src/commands/package/push-upgrade/schedule.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/uninstall.ts)_
756
+ _See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/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.1/src/commands/package/uninstall/report.ts)_
789
+ _See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/uninstall/report.ts)_
790
790
 
791
791
  ## `sf package update`
792
792
 
@@ -849,7 +849,7 @@ FLAG DESCRIPTIONS
849
849
  notified to upgrade to the recommended version.
850
850
  ```
851
851
 
852
- _See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/update.ts)_
852
+ _See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/update.ts)_
853
853
 
854
854
  ## `sf package version create`
855
855
 
@@ -1024,7 +1024,7 @@ FLAG DESCRIPTIONS
1024
1024
  periods of no output from commands.
1025
1025
  ```
1026
1026
 
1027
- _See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/create.ts)_
1027
+ _See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/create.ts)_
1028
1028
 
1029
1029
  ## `sf package version create list`
1030
1030
 
@@ -1085,7 +1085,7 @@ EXAMPLES
1085
1085
  $ sf package version create list --created-last-days 0 --status Success
1086
1086
  ```
1087
1087
 
1088
- _See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/create/list.ts)_
1088
+ _See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/create/list.ts)_
1089
1089
 
1090
1090
  ## `sf package version create report`
1091
1091
 
@@ -1128,7 +1128,7 @@ EXAMPLES
1128
1128
  $ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com
1129
1129
  ```
1130
1130
 
1131
- _See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/create/report.ts)_
1131
+ _See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/create/report.ts)_
1132
1132
 
1133
1133
  ## `sf package version delete`
1134
1134
 
@@ -1169,7 +1169,7 @@ EXAMPLES
1169
1169
  $ sf package version delete --package 04t... --target-org devhub@example.com
1170
1170
  ```
1171
1171
 
1172
- _See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/delete.ts)_
1172
+ _See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/delete.ts)_
1173
1173
 
1174
1174
  ## `sf package version displayancestry`
1175
1175
 
@@ -1229,7 +1229,7 @@ FLAG DESCRIPTIONS
1229
1229
  You can use the DOT code output in graph visualization software to create tree visualizations.
1230
1230
  ```
1231
1231
 
1232
- _See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/displayancestry.ts)_
1232
+ _See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/displayancestry.ts)_
1233
1233
 
1234
1234
  ## `sf package version displaydependencies`
1235
1235
 
@@ -1291,7 +1291,7 @@ FLAG DESCRIPTIONS
1291
1291
  package, which must be installed last.
1292
1292
  ```
1293
1293
 
1294
- _See code: [src/commands/package/version/displaydependencies.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/displaydependencies.ts)_
1294
+ _See code: [src/commands/package/version/displaydependencies.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/displaydependencies.ts)_
1295
1295
 
1296
1296
  ## `sf package version list`
1297
1297
 
@@ -1367,7 +1367,7 @@ EXAMPLES
1367
1367
  $ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
1368
1368
  ```
1369
1369
 
1370
- _See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/list.ts)_
1370
+ _See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/list.ts)_
1371
1371
 
1372
1372
  ## `sf package version promote`
1373
1373
 
@@ -1411,7 +1411,7 @@ EXAMPLES
1411
1411
  $ sf package version promote --package "Awesome Package Alias"
1412
1412
  ```
1413
1413
 
1414
- _See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/promote.ts)_
1414
+ _See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/promote.ts)_
1415
1415
 
1416
1416
  ## `sf package version report`
1417
1417
 
@@ -1451,7 +1451,7 @@ EXAMPLES
1451
1451
  $ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com
1452
1452
  ```
1453
1453
 
1454
- _See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/report.ts)_
1454
+ _See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/report.ts)_
1455
1455
 
1456
1456
  ## `sf package version retrieve`
1457
1457
 
@@ -1496,7 +1496,7 @@ EXAMPLES
1496
1496
  $ sf package version retrieve --package 04tXXX --output-dir my-directory/ --target-dev-hub devhub@example.com
1497
1497
  ```
1498
1498
 
1499
- _See code: [src/commands/package/version/retrieve.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/retrieve.ts)_
1499
+ _See code: [src/commands/package/version/retrieve.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/retrieve.ts)_
1500
1500
 
1501
1501
  ## `sf package version update`
1502
1502
 
@@ -1549,7 +1549,7 @@ EXAMPLES
1549
1549
  $ sf package version update --package 04t... --version-description "New Package Version Description"
1550
1550
  ```
1551
1551
 
1552
- _See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package/version/update.ts)_
1552
+ _See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package/version/update.ts)_
1553
1553
 
1554
1554
  ## `sf package1 version create`
1555
1555
 
@@ -1616,7 +1616,7 @@ FLAG DESCRIPTIONS
1616
1616
  subscribers.
1617
1617
  ```
1618
1618
 
1619
- _See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package1/version/create.ts)_
1619
+ _See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package1/version/create.ts)_
1620
1620
 
1621
1621
  ## `sf package1 version create get`
1622
1622
 
@@ -1649,7 +1649,7 @@ EXAMPLES
1649
1649
  $ sf package1 version create get --request-id 0HD... --target-org myorg@example.com
1650
1650
  ```
1651
1651
 
1652
- _See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package1/version/create/get.ts)_
1652
+ _See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package1/version/create/get.ts)_
1653
1653
 
1654
1654
  ## `sf package1 version display`
1655
1655
 
@@ -1683,7 +1683,7 @@ EXAMPLES
1683
1683
  $ sf package1 version display --package-version-id 04t... --target-org myorg@example.com
1684
1684
  ```
1685
1685
 
1686
- _See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package1/version/display.ts)_
1686
+ _See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package1/version/display.ts)_
1687
1687
 
1688
1688
  ## `sf package1 version list`
1689
1689
 
@@ -1721,6 +1721,6 @@ FLAG DESCRIPTIONS
1721
1721
  If not specified, shows all versions for all packages (managed and unmanaged) in the org.
1722
1722
  ```
1723
1723
 
1724
- _See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.1/src/commands/package1/version/list.ts)_
1724
+ _See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.24.2/src/commands/package1/version/list.ts)_
1725
1725
 
1726
1726
  <!-- 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 that contains one or more 2GP managed packages.
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
- sf package bundle create --name "Your bundle name" --description "Your bundle description" --target-dev-hub devhub@example.com
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 creation to complete.
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 detail.
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 version in the target org.
3
+ Install a specific version of a package bundle in the target org.
4
4
 
5
5
  # description
6
6
 
7
- Install a specific version of a package bundle in the target org. During developer preview, bundles can be installed only in scratch orgs.
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 00Dxx0000000000 --wait 10
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 (format: BundleName@Version or bundle version ID).
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
- Target org for the bundle installation.
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
- Specify the Dev Hub org ID directly (such as 00Dxx0000000000).
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 detail.
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 supply the request ID.
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
- Displays additional information at a slight performance cost, such as validation text for each package bundle install request.
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 00:00:00 of first day to now. Use 0 for today.
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 status Error:
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 status Queued:
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 installation requests with status Success that were created today:
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
- Use this command to check the status of a package bundle installation request. The command returns information about the request, including its current status and details about the package bundle version being installed.
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
- The ID of the package bundle installation request to report on.
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
 
@@ -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 specified Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
7
+ - List all package bundles in the Dev Hub org with the username `devhub@example.com`:
8
8
 
9
- sf package bundle list --target-dev-hub <dev_hub_alias>
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
- Id
21
+ ID
22
22
 
23
23
  # bundle-id
24
24
 
25
- Package Bundle Id
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 bundle detail.
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
- Create a new version of a package bundle with the specified components.
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 new version of a package bundle:
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
- sf package bundle version create -b MyBundle -p path/to/definition.json
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
- The name or ID of the package bundle to create a version for.
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 the JSON file containing the list of components to include in the bundle version.
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 command to complete before timing out.
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 Bundle version creation completed with status: %s
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
- Bundle version creation is %s. Use 'sf package bundle version create report -i %s' to check the status later.
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 Bundle version creation completed with status: %s
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 supply the request ID.
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 version creation request, used to filter the list.
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 output to display only converted package bundle version.
19
+ Filter the list to display only converted package bundle versions.
20
20
 
21
21
  # flags.verbose.summary
22
22
 
23
- Displays additional information at a slight performance cost, such as the version name and number for each package version create request.
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 00:00:00 of first day to now. Use 0 for today.
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 3 days in the Dev Hub org with username devhub@example.com:
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 status Error:
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 status Queued:
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 status Success that were created today:
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 Id
61
+ Package Bundle ID
62
62
 
63
63
  # packageVersionId
64
64
 
65
- Package Bundle Version Id
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 Id
73
+ Converted From Version ID