Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion command-snapshot.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,40 @@
"flags": ["api-version", "description", "flags-dir", "json", "loglevel", "name", "target-dev-hub"],
"plugin": "@salesforce/plugin-packaging"
},
{
"alias": [],
"command": "package:bundle:install",
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername", "targetusername", "u"],
"flagChars": ["b", "o", "v", "w"],
"flags": [
"api-version",
"bundle",
"flags-dir",
"json",
"loglevel",
"target-dev-hub",
"target-org",
"verbose",
"wait"
],
"plugin": "@salesforce/plugin-packaging"
},
{
"alias": [],
"command": "package:bundle:install:list",
"flagAliases": ["apiversion", "createdlastdays", "target-hub-org", "targetdevhubusername"],
"flagChars": ["c", "s", "v"],
"flags": ["api-version", "created-last-days", "flags-dir", "json", "loglevel", "status", "target-org", "verbose"],
"plugin": "@salesforce/plugin-packaging"
},
{
"alias": [],
"command": "package:bundle:install:report",
"flagAliases": ["apiversion", "packageinstallrequestid", "target-hub-org", "targetdevhubusername"],
"flagChars": ["i", "v"],
"flags": ["api-version", "flags-dir", "json", "loglevel", "package-install-request-id", "target-org", "verbose"],
"plugin": "@salesforce/plugin-packaging"
},
{
"alias": [],
"command": "package:bundle:delete",
Expand Down Expand Up @@ -136,7 +170,7 @@
"alias": [],
"command": "package:bundle:version:report",
"flagAliases": ["apiversion", "target-hub-org", "targetdevhubusername"],
"flagChars": ["p", "v"],
"flagChars": ["b", "v"],
"flags": ["api-version", "bundle-version", "flags-dir", "json", "loglevel", "target-dev-hub", "verbose"],
"plugin": "@salesforce/plugin-packaging"
},
Expand Down
54 changes: 54 additions & 0 deletions messages/bundle_install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# summary

Install a package bundle version in the target org.

# description

Install a specific version of a package bundle in the target org. During developer preview, bundles can be installed only in scratch orgs.

# examples

Install a package bundle version in a scratch org:

sf package bundle install --bundle MyPkgBundle1@0.1 --target-org my-scratch-org --wait 10

# flags.bundle.summary

Package bundle version to install (format: BundleName@Version).

# flags.target-org.summary

Target org for the bundle installation.

# flags.wait.summary

Number of minutes to wait for the installation to complete.

# flags.verbose.summary

Display extended installation detail.

# requestInProgress

Installing bundle.

# bundleInstallWaitingStatus

%d minutes remaining until timeout. Install status: %s

# bundleInstallFinalStatus

Install status: %s

# bundleInstallSuccess

Successfully installed bundle [%s]

# bundleInstallError

Encountered errors installing the bundle! %s

# bundleInstallInProgress

Bundle installation is currently %s. You can continue to query the status using
sf package bundle install:report -i %s -o %s
69 changes: 69 additions & 0 deletions messages/bundle_install_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# summary

List package bundle installation requests.

# description

Shows the details of each request to install a package bundle version in the target org.

All filter parameters are applied using the AND logical operator (not OR).

To get information about a specific request, run "<%= config.bin %> package bundle install report" and supply the request ID.

# flags.status.summary

Status of the installation request, used to filter the list.

# flags.verbose.summary

Displays additional information at a slight performance cost, such as validation text for each package bundle install request.

# flags.created-last-days.summary

Number of days since the request was created, starting at 00:00:00 of first day to now. Use 0 for today.

# examples

- List all package bundle installation requests in your default Dev Hub org:

<%= config.bin %> <%= command.id %>

- List package bundle installation requests from the last 3 days in the Dev Hub org with username devhub@example.com:

<%= config.bin %> <%= command.id %> --created-last-days 3 --target-dev-hub

- List package bundle installation requests with status Error:

<%= config.bin %> <%= command.id %> --status Error

- List package bundle installation requests with status Queued:

<%= config.bin %> <%= command.id %> --status Queued

- List package bundle installation requests with status Success that were created today:

<%= config.bin %> <%= command.id %> --created-last-days 0 --status Success

# id

ID

# status

Status

# package-bundle-version-id

Package Bundle Version ID

# development-organization

Development Organization

# created-by

Created By

# validation-error

Validation Error
53 changes: 53 additions & 0 deletions messages/bundle_install_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# summary

Report on the status of a package bundle installation request.

# description

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.

# examples

- Report on a package bundle installation request:

<%= config.bin %> <%= command.id %> --package-install-request-id 0Ho0x0000000000000

- Report on a package bundle installation request using an alias:

<%= config.bin %> force:package:bundle:install:report -i 0Ho0x0000000000000

# flags.package-install-request-id.summary

The ID of the package bundle installation request to report on.

# id

ID

# status

Status

# package-bundle-version-id

Package Bundle Version ID

# development-organization

Development Organization

# validation-error

Validation Error

# created-date

Created Date

# created-by

Created By

# flags.verbose.summary

Show verbose output.
58 changes: 58 additions & 0 deletions schemas/package-bundle-install-list.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "#/definitions/PackageBundleInstallRequestResults",
"definitions": {
"PackageBundleInstallRequestResults": {
"type": "array",
"items": {
"$ref": "#/definitions/BundleSObjects.PkgBundleVersionInstallReqResult"
}
},
"BundleSObjects.PkgBundleVersionInstallReqResult": {
"type": "object",
"additionalProperties": false,
"properties": {
"Id": {
"type": "string"
},
"InstallStatus": {
"$ref": "#/definitions/BundleSObjects.PkgBundleVersionInstallReqStatus"
},
"ValidationError": {
"type": "string"
},
"CreatedDate": {
"type": "string"
},
"CreatedById": {
"type": "string"
},
"Error": {
"type": "array",
"items": {
"type": "string"
}
},
"PackageBundleVersionID": {
"type": "string"
},
"DevelopmentOrganization": {
"type": "string"
}
},
"required": [
"CreatedById",
"CreatedDate",
"DevelopmentOrganization",
"Id",
"InstallStatus",
"PackageBundleVersionID",
"ValidationError"
]
},
"BundleSObjects.PkgBundleVersionInstallReqStatus": {
"type": "string",
"enum": ["Queued", "Success", "Error"]
}
}
}
58 changes: 58 additions & 0 deletions schemas/package-bundle-install-report.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "#/definitions/ReportCommandResult",
"definitions": {
"ReportCommandResult": {
"type": "array",
"items": {
"$ref": "#/definitions/BundleSObjects.PkgBundleVersionInstallReqResult"
}
},
"BundleSObjects.PkgBundleVersionInstallReqResult": {
"type": "object",
"additionalProperties": false,
"properties": {
"Id": {
"type": "string"
},
"InstallStatus": {
"$ref": "#/definitions/BundleSObjects.PkgBundleVersionInstallReqStatus"
},
"ValidationError": {
"type": "string"
},
"CreatedDate": {
"type": "string"
},
"CreatedById": {
"type": "string"
},
"Error": {
"type": "array",
"items": {
"type": "string"
}
},
"PackageBundleVersionID": {
"type": "string"
},
"DevelopmentOrganization": {
"type": "string"
}
},
"required": [
"CreatedById",
"CreatedDate",
"DevelopmentOrganization",
"Id",
"InstallStatus",
"PackageBundleVersionID",
"ValidationError"
]
},
"BundleSObjects.PkgBundleVersionInstallReqStatus": {
"type": "string",
"enum": ["Queued", "Success", "Error"]
}
}
}
52 changes: 52 additions & 0 deletions schemas/package-bundle-install.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$ref": "#/definitions/BundleSObjects.PkgBundleVersionInstallReqResult",
"definitions": {
"BundleSObjects.PkgBundleVersionInstallReqResult": {
"type": "object",
"additionalProperties": false,
"properties": {
"Id": {
"type": "string"
},
"InstallStatus": {
"$ref": "#/definitions/BundleSObjects.PkgBundleVersionInstallReqStatus"
},
"ValidationError": {
"type": "string"
},
"CreatedDate": {
"type": "string"
},
"CreatedById": {
"type": "string"
},
"Error": {
"type": "array",
"items": {
"type": "string"
}
},
"PackageBundleVersionID": {
"type": "string"
},
"DevelopmentOrganization": {
"type": "string"
}
},
"required": [
"CreatedById",
"CreatedDate",
"DevelopmentOrganization",
"Id",
"InstallStatus",
"PackageBundleVersionID",
"ValidationError"
]
},
"BundleSObjects.PkgBundleVersionInstallReqStatus": {
"type": "string",
"enum": ["Queued", "Success", "Error"]
}
}
}
Loading
Loading