Skip to content

Commit 764f317

Browse files
WillieRuemmeleWillieRuemmele
authored
Merge pull request #1038 from salesforcecli/packagingDistribution/packageBundles
@W-19441295 Merge bundles CLI - plugin side
2 parents 670cee8 + e17a15d commit 764f317

47 files changed

Lines changed: 4730 additions & 91 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎command-snapshot.json‎

Lines changed: 124 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,126 @@
5555
"flags": ["api-version", "flags-dir", "json", "loglevel", "package-id", "target-org"],
5656
"plugin": "@salesforce/plugin-packaging"
5757
},
58+
{
59+
"alias": [],
60+
"command": "package:bundle:create",
61+
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername"],
62+
"flagChars": ["d", "n", "v"],
63+
"flags": ["api-version", "description", "flags-dir", "json", "loglevel", "name", "target-dev-hub"],
64+
"plugin": "@salesforce/plugin-packaging"
65+
},
66+
{
67+
"alias": [],
68+
"command": "package:bundle:delete",
69+
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername"],
70+
"flagChars": ["b", "n", "v"],
71+
"flags": ["api-version", "bundle", "flags-dir", "json", "loglevel", "no-prompt", "target-dev-hub"],
72+
"plugin": "@salesforce/plugin-packaging"
73+
},
74+
{
75+
"alias": [],
76+
"command": "package:bundle:install",
77+
"flagAliases": ["apiversion", "targetdevhubusername", "targetusername", "u"],
78+
"flagChars": ["b", "o", "v", "w"],
79+
"flags": [
80+
"api-version",
81+
"bundle",
82+
"flags-dir",
83+
"json",
84+
"loglevel",
85+
"target-dev-hub",
86+
"target-org",
87+
"verbose",
88+
"wait"
89+
],
90+
"plugin": "@salesforce/plugin-packaging"
91+
},
92+
{
93+
"alias": [],
94+
"command": "package:bundle:install:list",
95+
"flagAliases": ["apiversion", "targetusername", "u"],
96+
"flagChars": ["c", "o", "s"],
97+
"flags": ["api-version", "created-last-days", "flags-dir", "json", "loglevel", "status", "target-org", "verbose"],
98+
"plugin": "@salesforce/plugin-packaging"
99+
},
100+
{
101+
"alias": [],
102+
"command": "package:bundle:install:report",
103+
"flagAliases": ["apiversion", "targetusername", "u"],
104+
"flagChars": ["i", "o"],
105+
"flags": ["api-version", "flags-dir", "json", "loglevel", "package-install-request-id", "target-org", "verbose"],
106+
"plugin": "@salesforce/plugin-packaging"
107+
},
108+
{
109+
"alias": [],
110+
"command": "package:bundle:list",
111+
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername"],
112+
"flagChars": ["v"],
113+
"flags": ["api-version", "flags-dir", "json", "loglevel", "target-dev-hub", "verbose"],
114+
"plugin": "@salesforce/plugin-packaging"
115+
},
116+
{
117+
"alias": [],
118+
"command": "package:bundle:version:create",
119+
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername"],
120+
"flagChars": ["b", "d", "n", "p", "v", "w"],
121+
"flags": [
122+
"api-version",
123+
"bundle",
124+
"definition-file",
125+
"description",
126+
"flags-dir",
127+
"json",
128+
"loglevel",
129+
"target-dev-hub",
130+
"verbose",
131+
"version-number",
132+
"wait"
133+
],
134+
"plugin": "@salesforce/plugin-packaging"
135+
},
136+
{
137+
"alias": [],
138+
"command": "package:bundle:version:create:list",
139+
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername"],
140+
"flagChars": ["c", "s", "v"],
141+
"flags": [
142+
"api-version",
143+
"created-last-days",
144+
"flags-dir",
145+
"json",
146+
"loglevel",
147+
"show-conversions-only",
148+
"status",
149+
"target-dev-hub",
150+
"verbose"
151+
],
152+
"plugin": "@salesforce/plugin-packaging"
153+
},
154+
{
155+
"alias": [],
156+
"command": "package:bundle:version:create:report",
157+
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername"],
158+
"flagChars": ["i", "v"],
159+
"flags": ["api-version", "bundle-version-create-request-id", "flags-dir", "json", "loglevel", "target-dev-hub"],
160+
"plugin": "@salesforce/plugin-packaging"
161+
},
162+
{
163+
"alias": [],
164+
"command": "package:bundle:version:list",
165+
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername"],
166+
"flagChars": ["v"],
167+
"flags": ["api-version", "flags-dir", "json", "loglevel", "target-dev-hub", "verbose"],
168+
"plugin": "@salesforce/plugin-packaging"
169+
},
170+
{
171+
"alias": [],
172+
"command": "package:bundle:version:report",
173+
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername"],
174+
"flagChars": ["b", "v"],
175+
"flags": ["api-version", "bundle-version", "flags-dir", "json", "loglevel", "target-dev-hub", "verbose"],
176+
"plugin": "@salesforce/plugin-packaging"
177+
},
58178
{
59179
"alias": ["force:package:convert"],
60180
"command": "package:convert",
@@ -66,13 +186,13 @@
66186
"installationkeybypass",
67187
"patchversion",
68188
"target-hub-org",
69-
"targetdevhubusername",
70-
"codecoverage"
189+
"targetdevhubusername"
71190
],
72-
"flagChars": ["a", "f", "k", "m", "p", "s", "v", "w", "x", "c"],
191+
"flagChars": ["a", "c", "f", "k", "m", "p", "s", "v", "w", "x"],
73192
"flags": [
74193
"api-version",
75194
"build-instance",
195+
"code-coverage",
76196
"definition-file",
77197
"flags-dir",
78198
"installation-key",
@@ -84,8 +204,7 @@
84204
"seed-metadata",
85205
"target-dev-hub",
86206
"verbose",
87-
"wait",
88-
"code-coverage"
207+
"wait"
89208
],
90209
"plugin": "@salesforce/plugin-packaging"
91210
},

‎messages/bundle_create.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# summary
2+
3+
Create a package bundle in the Dev Hub org.
4+
5+
# description
6+
7+
A package bundle is an artifact that contains one or more 2GP managed packages.
8+
A bundle can be listed on AppExchange, installed, or upgraded as a single artifact.
9+
10+
# examples
11+
12+
Create a package bundle in the Dev Hub org; uses the Dev Hub org with the username devhub@example.com:
13+
14+
sf package bundle create --name "Your bundle name" --description "Your bundle description" --target-dev-hub devhub@example.com
15+
16+
# flags.name.summary
17+
18+
Name of the package bundle.
19+
20+
# flags.description.summary
21+
22+
Description of the package bundle.
23+
24+
# flags.wait.summary
25+
26+
Number of minutes to wait for the bundle creation to complete.
27+
28+
# flags.verbose.summary
29+
30+
Display extended bundle creation detail.
31+
32+
# requestInProgress
33+
34+
Creating bundle.
35+
36+
# bundleCreateWaitingStatus
37+
38+
%d minutes remaining until timeout. Create bundle status: %s
39+
40+
# bundleCreateFinalStatus
41+
42+
Create bundle status: %s

‎messages/bundle_install.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# summary
2+
3+
Install a package bundle version in the target org.
4+
5+
# description
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.
8+
9+
# examples
10+
11+
Install a package bundle version in a scratch org:
12+
13+
sf package bundle install --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --wait 10
14+
15+
# flags.bundle.summary
16+
17+
Package bundle version to install (format: BundleName@Version).
18+
19+
# flags.target-org.summary
20+
21+
Target org for the bundle installation.
22+
23+
# flags.target-dev-hub.summary
24+
25+
Username, alias, or org ID of the target dev hub org.
26+
27+
# flags.wait.summary
28+
29+
Number of minutes to wait for the installation to complete.
30+
31+
# flags.verbose.summary
32+
33+
Display extended installation detail.
34+
35+
# requestInProgress
36+
37+
Installing bundle.
38+
39+
# bundleInstallWaitingStatus
40+
41+
%d minutes remaining until timeout. Install status: %s
42+
43+
# bundleInstallFinalStatus
44+
45+
Install status: %s
46+
47+
# bundleInstallSuccess
48+
49+
Successfully installed bundle [%s]
50+
51+
# bundleInstallError
52+
53+
Encountered errors installing the bundle! %s
54+
55+
# bundleInstallInProgress
56+
57+
Bundle installation is currently %s. You can continue to query the status using
58+
sf package bundle install:report -i %s -o %s

‎messages/bundle_install_list.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# summary
2+
3+
List package bundle installation requests.
4+
5+
# description
6+
7+
Shows the details of each request to install a package bundle version in the target org.
8+
9+
All filter parameters are applied using the AND logical operator (not OR).
10+
11+
To get information about a specific request, run "<%= config.bin %> package bundle install report" and supply the request ID.
12+
13+
# flags.status.summary
14+
15+
Status of the installation request, used to filter the list.
16+
17+
# flags.verbose.summary
18+
19+
Displays additional information at a slight performance cost, such as validation text for each package bundle install request.
20+
21+
# flags.created-last-days.summary
22+
23+
Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.
24+
25+
# examples
26+
27+
- List all package bundle installation requests in your default Dev Hub org:
28+
29+
<%= config.bin %> <%= command.id %>
30+
31+
- List package bundle installation requests from the last 3 days in the Dev Hub org with username devhub@example.com:
32+
33+
<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub
34+
35+
- List package bundle installation requests with status Error:
36+
37+
<%= config.bin %> <%= command.id %> --status Error
38+
39+
- List package bundle installation requests with status Queued:
40+
41+
<%= config.bin %> <%= command.id %> --status Queued
42+
43+
- List package bundle installation requests with status Success that were created today:
44+
45+
<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success
46+
47+
# id
48+
49+
ID
50+
51+
# status
52+
53+
Status
54+
55+
# package-bundle-version-id
56+
57+
Package Bundle Version ID
58+
59+
# development-organization
60+
61+
Development Organization
62+
63+
# created-by
64+
65+
Created By
66+
67+
# validation-error
68+
69+
Validation Error

‎messages/bundle_install_report.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# summary
2+
3+
Report on the status of a package bundle installation request.
4+
5+
# description
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.
8+
9+
# examples
10+
11+
- Report on a package bundle installation request:
12+
13+
<%= config.bin %> <%= command.id %> --package-install-request-id 0Ho0x0000000000000
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+
# flags.package-install-request-id.summary
20+
21+
The ID of the package bundle installation request to report on.
22+
23+
# id
24+
25+
ID
26+
27+
# status
28+
29+
Status
30+
31+
# package-bundle-version-id
32+
33+
Package Bundle Version ID
34+
35+
# development-organization
36+
37+
Development Organization
38+
39+
# validation-error
40+
41+
Validation Error
42+
43+
# created-date
44+
45+
Created Date
46+
47+
# created-by
48+
49+
Created By
50+
51+
# flags.verbose.summary
52+
53+
Show verbose output.

0 commit comments

Comments
 (0)