diff --git a/README.md b/README.md index 9c9c3c4c0..dd2764b88 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ $ npm install -g @salesforce/cli $ sf COMMAND running command... $ sf (--version|-v) -@salesforce/cli/2.93.0 linux-x64 node-v22.16.0 +@salesforce/cli/2.93.1 linux-x64 node-v22.16.0 $ sf --help [COMMAND] USAGE $ sf COMMAND @@ -141,6 +141,10 @@ See [architecture page](ARCHITECTURE.md) for diagrams of the Salesforce CLI. - [`sf package install report`](#sf-package-install-report) - [`sf package installed list`](#sf-package-installed-list) - [`sf package list`](#sf-package-list) +- [`sf package push-upgrade abort`](#sf-package-push-upgrade-abort) +- [`sf package push-upgrade list`](#sf-package-push-upgrade-list) +- [`sf package push-upgrade report`](#sf-package-push-upgrade-report) +- [`sf package push-upgrade schedule`](#sf-package-push-upgrade-schedule) - [`sf package uninstall`](#sf-package-uninstall) - [`sf package uninstall report`](#sf-package-uninstall-report) - [`sf package update`](#sf-package-update) @@ -5585,7 +5589,7 @@ FLAG DESCRIPTIONS --installation-key-bypass flag is required. ``` -_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/convert.ts)_ +_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.15.0/src/commands/package/convert.ts)_ ## `sf package create` @@ -5664,7 +5668,7 @@ FLAG DESCRIPTIONS Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide. ``` -_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/create.ts)_ +_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.15.0/src/commands/package/create.ts)_ ## `sf package delete` @@ -5706,7 +5710,7 @@ EXAMPLES $ sf package delete --package 0Ho... --target-dev-hub devhub@example.com ``` -_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/delete.ts)_ +_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.15.0/src/commands/package/delete.ts)_ ## `sf package install` @@ -5805,7 +5809,7 @@ FLAG DESCRIPTIONS - Delete: Delete all removed components that can be safely deleted, and deprecate the other components. ``` -_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/install.ts)_ +_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.15.0/src/commands/package/install.ts)_ ## `sf package install report` @@ -5838,7 +5842,7 @@ EXAMPLES $ sf package install report --request-id 0Hf... --target-org me@example.com ``` -_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/install/report.ts)_ +_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.15.0/src/commands/package/install/report.ts)_ ## `sf package installed list` @@ -5870,7 +5874,7 @@ EXAMPLES $ sf package installed list --target-org me@example.com ``` -_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/installed/list.ts)_ +_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.15.0/src/commands/package/installed/list.ts)_ ## `sf package list` @@ -5908,7 +5912,230 @@ EXAMPLES $ sf package list --target-dev-hub devhub@example.com --verbose ``` -_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.14.0/src/commands/package/list.ts)_ +_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.15.0/src/commands/package/list.ts)_ + +## `sf package push-upgrade abort` + +Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending can be aborted. + +``` +USAGE + $ sf package push-upgrade abort -v -i [--json] [--flags-dir ] [--api-version ] + +FLAGS + -i, --push-request-id= (required) ID of the package push request (starts with 0DV). This ID is returned after + the package push-upgrade schedule command completes successfully. + -v, --target-dev-hub= (required) Username or alias of the Dev Hub org. Not required if the `target-dev-hub` + configuration variable is already set. + --api-version= Override the api version used for api requests made by this command + +GLOBAL FLAGS + --flags-dir= Import flag values from a directory. + --json Format output as json. + +DESCRIPTION + Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending + can be aborted. + + Specify the request ID for which you want abort the request. If applicable, the command displays errors related to the + request. + + To show all requests in the org, run "sf package pushupgrade list --package 033...". + +EXAMPLES + Cancel the specified package push upgrade request with the specified ID; uses your default Dev Hub org: + + $ sf package push-upgrade abort --push-request-id 0DV... + + Cancel the specified package push upgrade request in the Dev Hub org with username devhub@example.com: + + $ sf package push-upgrade abort --push-request-id 0DV... --target-dev-hub devhub@example.com +``` + +_See code: [@salesforce/plugin-packaging](https://github.com/salesforcecli/plugin-packaging/blob/2.15.0/src/commands/package/push-upgrade/abort.ts)_ + +## `sf package push-upgrade list` + +Lists the status of push upgrade requests for a given package. + +``` +USAGE + $ sf package push-upgrade list -v -p [--json] [--flags-dir ] [--api-version ] [-l ] [-s + Created|Cancelled|Pending|In Progress|Failed|Succeeded] [--show-push-migrations-only] + +FLAGS + -l, --scheduled-last-days= Number of days in the past for which to display the list of push upgrade requests + that were scheduled. Used to filter the list output to only recently scheduled push + upgrades. + -p, --package= (required) Package ID (starts with 033) of the package that you want push upgrade + information for. + -s, --status=