From 7f5b9db7743fed527a6d944f57559381c1302dba Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Sat, 18 May 2024 05:45:46 +0000 Subject: [PATCH] chore(release): 2.4.5 [skip ci] --- CHANGELOG.md | 6 + README.md | 388 +++++++++++++++++++++++++-------------------------- package.json | 2 +- 3 files changed, 201 insertions(+), 195 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 41c21410..2497d1d9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [2.4.5](https://github.com/salesforcecli/plugin-packaging/compare/2.4.4...2.4.5) (2024-05-18) + +### Bug Fixes + +- **deps:** bump @salesforce/core from 7.3.6 to 7.3.8 ([9a38592](https://github.com/salesforcecli/plugin-packaging/commit/9a3859269ce380f3c43b6686a1e595b699f577d3)) + ## [2.4.4](https://github.com/salesforcecli/plugin-packaging/compare/2.4.3...2.4.4) (2024-05-14) ### Bug Fixes diff --git a/README.md b/README.md index 4b9bf772..55aeae01 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,6 @@ See [DEVELOPING.md](DEVELOPING.md) -- [`sf package1 version create`](#sf-package1-version-create) -- [`sf package1 version create get`](#sf-package1-version-create-get) -- [`sf package1 version display`](#sf-package1-version-display) -- [`sf package1 version list`](#sf-package1-version-list) - [`sf package create`](#sf-package-create) - [`sf package delete`](#sf-package-delete) - [`sf package install`](#sf-package-install) @@ -52,178 +48,10 @@ See [DEVELOPING.md](DEVELOPING.md) - [`sf package version promote`](#sf-package-version-promote) - [`sf package version report`](#sf-package-version-report) - [`sf package version update`](#sf-package-version-update) - -## `sf package1 version create` - -Create a first-generation package version in the release org. - -``` -USAGE - $ sf package1 version create -o -i -n [--json] [--flags-dir ] [--api-version ] [-d - ] [-v ] [-m] [-r ] [-p ] [-k ] [-w ] - -FLAGS - -d, --description= Package version description. - -i, --package-id= (required) ID of the metadata package (starts with 033) of which you’re creating a - new version. - -k, --installation-key= Installation key for key-protected package (default: null). - -m, --managed-released Create a managed package version. - -n, --name= (required) Package version name. - -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` - configuration variable is already set. - -p, --post-install-url= Post install URL. - -r, --release-notes-url= Release notes URL. - -v, --version= Package version in major.minor format, for example, 3.2. - -w, --wait= Minutes to wait for the package version to be created (default: 2 minutes). - --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 - Create a first-generation package version in the release org. - - The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to - create an unmanaged package version. - -ALIASES - $ sf force package1 version create - -EXAMPLES - Create a first-generation package version from the package with the specified ID and name the package version - "example"; use your default org: - - $ sf package1 version create --package-id 033... --name example - - Same as previous example, but provide a description and wait for 30 minutes for the package version to be created; - use the specified org: - - $ sf package1 version create --package-id 033... --name example --description "example description" --wait 30 \ - --target-org myorg@example.com - -FLAG DESCRIPTIONS - -m, --managed-released Create a managed package version. - - To create a beta version, don’t include this parameter. - - -p, --post-install-url= Post install URL. - - The contents of the post-installation instructions URL are displayed in the UI after installation of the package - version. - - -r, --release-notes-url= Release notes URL. - - This link is displayed in the package installation UI to provide release notes for this package version to - subscribers. -``` - -_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package1/version/create.ts)_ - -## `sf package1 version create get` - -Retrieve the status of a package version creation request. - -``` -USAGE - $ sf package1 version create get -o -i [--json] [--flags-dir ] [--api-version ] - -FLAGS - -i, --request-id= (required) ID of the PackageUploadRequest (starts with 0HD). - -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` - 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. - -ALIASES - $ sf force package1 version create get - -EXAMPLES - Get the status of the creation request for the package version with the specified ID in your default org: - - $ sf package1 version create get --request-id 0HD... - - Same as previous example, but use the specified org: - - $ sf package1 version create get --request-id 0HD... --target-org myorg@example.com -``` - -_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package1/version/create/get.ts)_ - -## `sf package1 version display` - -Display details about a first-generation package version. - -``` -USAGE - $ sf package1 version display -o -i [--json] [--flags-dir ] [--api-version ] - -FLAGS - -i, --package-version-id= (required) ID (starts with 04t) of the metadata package version whose details you - want to display. - -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` - 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. - -ALIASES - $ sf force package1 version display - -EXAMPLES - Display details about the first-generation package version with the specified ID in your default org: - - $ sf package1 version display --package-version-id 04t... - - Same as previous example, but use the specified org: - - $ sf package1 version display --package-version-id 04t... --target-org myorg@example.com -``` - -_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package1/version/display.ts)_ - -## `sf package1 version list` - -List package versions for the specified first-generation package or for the org. - -``` -USAGE - $ sf package1 version list -o [--json] [--flags-dir ] [--api-version ] [-i ] - -FLAGS - -i, --package-id= Metadata package ID (starts with 033) whose package versions you want to list. - -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` - 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. - -ALIASES - $ sf force package1 version list - -EXAMPLES - List all first-generation package versions in your default org: - - $ sf package1 version list - - List package versions for the specified first-generation package in the specifief org: - - $ sf package1 version list --package-id 033... --target-org myorg@example.com - -FLAG DESCRIPTIONS - -i, --package-id= Metadata package ID (starts with 033) whose package versions you want to list. - - If not specified, shows all versions for all packages (managed and unmanaged) in the org. -``` - -_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package1/version/list.ts)_ +- [`sf package1 version create`](#sf-package1-version-create) +- [`sf package1 version create get`](#sf-package1-version-create-get) +- [`sf package1 version display`](#sf-package1-version-display) +- [`sf package1 version list`](#sf-package1-version-list) ## `sf package create` @@ -302,7 +130,7 @@ FLAG DESCRIPTIONS Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide. ``` -_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/create.ts)_ +_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/create.ts)_ ## `sf package delete` @@ -344,7 +172,7 @@ EXAMPLES $ sf package delete --package 0Ho... --target-dev-hub devhub@example.com ``` -_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/delete.ts)_ +_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/delete.ts)_ ## `sf package install` @@ -442,7 +270,7 @@ FLAG DESCRIPTIONS specify DeprecateOnly or Delete only for unlocked package upgrades. ``` -_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/install.ts)_ +_See code: [src/commands/package/install.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/install.ts)_ ## `sf package install report` @@ -475,7 +303,7 @@ EXAMPLES $ sf package install report --request-id 0Hf... --target-org me@example.com ``` -_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/install/report.ts)_ +_See code: [src/commands/package/install/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/install/report.ts)_ ## `sf package installed list` @@ -507,7 +335,7 @@ EXAMPLES $ sf package installed list --target-org me@example.com ``` -_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/installed/list.ts)_ +_See code: [src/commands/package/installed/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/installed/list.ts)_ ## `sf package list` @@ -545,7 +373,7 @@ EXAMPLES $ sf package list --target-dev-hub devhub@example.com --verbose ``` -_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/list.ts)_ +_See code: [src/commands/package/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/list.ts)_ ## `sf package uninstall` @@ -593,7 +421,7 @@ EXAMPLES $ sf package uninstall --package "Undesirable Package Alias" ``` -_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/uninstall.ts)_ +_See code: [src/commands/package/uninstall.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/uninstall.ts)_ ## `sf package uninstall report` @@ -626,7 +454,7 @@ EXAMPLES $ sf package uninstall report --request-id 06y... --target-org me@example.com ``` -_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/uninstall/report.ts)_ +_See code: [src/commands/package/uninstall/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/uninstall/report.ts)_ ## `sf package update` @@ -681,7 +509,7 @@ FLAG DESCRIPTIONS associated with your package. ``` -_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/update.ts)_ +_See code: [src/commands/package/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/update.ts)_ ## `sf package version create` @@ -836,7 +664,7 @@ FLAG DESCRIPTIONS periods of no output from commands. ``` -_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/version/create.ts)_ +_See code: [src/commands/package/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/create.ts)_ ## `sf package version create list` @@ -897,7 +725,7 @@ EXAMPLES $ sf package version create list --created-last-days 0 --status Success ``` -_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/version/create/list.ts)_ +_See code: [src/commands/package/version/create/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/create/list.ts)_ ## `sf package version create report` @@ -940,7 +768,7 @@ EXAMPLES $ sf package version create report --package-create-request-id 08c... --target-dev-hub devhub@example.com ``` -_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/version/create/report.ts)_ +_See code: [src/commands/package/version/create/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/create/report.ts)_ ## `sf package version delete` @@ -979,7 +807,7 @@ EXAMPLES $ sf package version delete --package 04t... --target-org devhub@example.com ``` -_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/version/delete.ts)_ +_See code: [src/commands/package/version/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/delete.ts)_ ## `sf package version displayancestry` @@ -1039,7 +867,7 @@ FLAG DESCRIPTIONS You can use the DOT code output in graph visualization software to create tree visualizations. ``` -_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/version/displayancestry.ts)_ +_See code: [src/commands/package/version/displayancestry.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/displayancestry.ts)_ ## `sf package version list` @@ -1108,7 +936,7 @@ EXAMPLES $ sf package version list --packages exp-mgr,exp-mgr-util --released --modified-last-days 0 ``` -_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/version/list.ts)_ +_See code: [src/commands/package/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/list.ts)_ ## `sf package version promote` @@ -1152,7 +980,7 @@ EXAMPLES $ sf package version promote --package "Awesome Package Alias" ``` -_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/version/promote.ts)_ +_See code: [src/commands/package/version/promote.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/promote.ts)_ ## `sf package version report` @@ -1192,7 +1020,7 @@ EXAMPLES $ sf package version report --package "Your Package Alias" --target-dev-hub devhub@example.com ``` -_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/version/report.ts)_ +_See code: [src/commands/package/version/report.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/report.ts)_ ## `sf package version update` @@ -1245,6 +1073,178 @@ EXAMPLES $ sf package version update --package 04t... --version-description "New Package Version Description" ``` -_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.4/src/commands/package/version/update.ts)_ +_See code: [src/commands/package/version/update.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package/version/update.ts)_ + +## `sf package1 version create` + +Create a first-generation package version in the release org. + +``` +USAGE + $ sf package1 version create -o -i -n [--json] [--flags-dir ] [--api-version ] [-d + ] [-v ] [-m] [-r ] [-p ] [-k ] [-w ] + +FLAGS + -d, --description= Package version description. + -i, --package-id= (required) ID of the metadata package (starts with 033) of which you’re creating a + new version. + -k, --installation-key= Installation key for key-protected package (default: null). + -m, --managed-released Create a managed package version. + -n, --name= (required) Package version name. + -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` + configuration variable is already set. + -p, --post-install-url= Post install URL. + -r, --release-notes-url= Release notes URL. + -v, --version= Package version in major.minor format, for example, 3.2. + -w, --wait= Minutes to wait for the package version to be created (default: 2 minutes). + --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 + Create a first-generation package version in the release org. + + The package version is based on the contents of the specified metadata package. Omit --managed-released if you want to + create an unmanaged package version. + +ALIASES + $ sf force package1 version create + +EXAMPLES + Create a first-generation package version from the package with the specified ID and name the package version + "example"; use your default org: + + $ sf package1 version create --package-id 033... --name example + + Same as previous example, but provide a description and wait for 30 minutes for the package version to be created; + use the specified org: + + $ sf package1 version create --package-id 033... --name example --description "example description" --wait 30 \ + --target-org myorg@example.com + +FLAG DESCRIPTIONS + -m, --managed-released Create a managed package version. + + To create a beta version, don’t include this parameter. + + -p, --post-install-url= Post install URL. + + The contents of the post-installation instructions URL are displayed in the UI after installation of the package + version. + + -r, --release-notes-url= Release notes URL. + + This link is displayed in the package installation UI to provide release notes for this package version to + subscribers. +``` + +_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package1/version/create.ts)_ + +## `sf package1 version create get` + +Retrieve the status of a package version creation request. + +``` +USAGE + $ sf package1 version create get -o -i [--json] [--flags-dir ] [--api-version ] + +FLAGS + -i, --request-id= (required) ID of the PackageUploadRequest (starts with 0HD). + -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` + 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. + +ALIASES + $ sf force package1 version create get + +EXAMPLES + Get the status of the creation request for the package version with the specified ID in your default org: + + $ sf package1 version create get --request-id 0HD... + + Same as previous example, but use the specified org: + + $ sf package1 version create get --request-id 0HD... --target-org myorg@example.com +``` + +_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package1/version/create/get.ts)_ + +## `sf package1 version display` + +Display details about a first-generation package version. + +``` +USAGE + $ sf package1 version display -o -i [--json] [--flags-dir ] [--api-version ] + +FLAGS + -i, --package-version-id= (required) ID (starts with 04t) of the metadata package version whose details you + want to display. + -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` + 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. + +ALIASES + $ sf force package1 version display + +EXAMPLES + Display details about the first-generation package version with the specified ID in your default org: + + $ sf package1 version display --package-version-id 04t... + + Same as previous example, but use the specified org: + + $ sf package1 version display --package-version-id 04t... --target-org myorg@example.com +``` + +_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package1/version/display.ts)_ + +## `sf package1 version list` + +List package versions for the specified first-generation package or for the org. + +``` +USAGE + $ sf package1 version list -o [--json] [--flags-dir ] [--api-version ] [-i ] + +FLAGS + -i, --package-id= Metadata package ID (starts with 033) whose package versions you want to list. + -o, --target-org= (required) Username or alias of the target org. Not required if the `target-org` + 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. + +ALIASES + $ sf force package1 version list + +EXAMPLES + List all first-generation package versions in your default org: + + $ sf package1 version list + + List package versions for the specified first-generation package in the specifief org: + + $ sf package1 version list --package-id 033... --target-org myorg@example.com + +FLAG DESCRIPTIONS + -i, --package-id= Metadata package ID (starts with 033) whose package versions you want to list. + + If not specified, shows all versions for all packages (managed and unmanaged) in the org. +``` + +_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/2.4.5/src/commands/package1/version/list.ts)_ diff --git a/package.json b/package.json index c2543c50..bb7f204c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/plugin-packaging", "description": "SF plugin that support Salesforce Packaging Platform", - "version": "2.4.4", + "version": "2.4.5", "author": "Salesforce", "bugs": "https://github.com/forcedotcom/cli/issues", "dependencies": {