diff --git a/CHANGELOG.md b/CHANGELOG.md index 4f9878bf..2aec1c07 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [1.27.5](https://github.com/salesforcecli/plugin-packaging/compare/1.27.4...1.27.5) (2023-11-30) + +### Bug Fixes + +- bump oclif ([5937490](https://github.com/salesforcecli/plugin-packaging/commit/5937490202bda5fa4226b5e6d64ad61534b26e40)) + ## [1.27.4](https://github.com/salesforcecli/plugin-packaging/compare/1.27.3...1.27.4) (2023-11-30) ## [1.27.3](https://github.com/salesforcecli/plugin-packaging/compare/1.27.2...1.27.3) (2023-11-25) diff --git a/README.md b/README.md index c16c85e5..6abdf0d3 100644 --- a/README.md +++ b/README.md @@ -59,8 +59,8 @@ Create a first-generation package version in the release org. ``` USAGE - $ sf package1:version:create -o -i -n [--api-version ] [-d ] [-v ] [-m] [-r - ] [-p ] [-k ] [-w ] + $ sf package1:version:create -o -i -n [--json] [--api-version ] [-d ] [-v ] + [-m] [-r ] [-p ] [-k ] [-w ] FLAGS -d, --description= Package version description. @@ -75,7 +75,10 @@ FLAGS -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 + --api-version= Override the api version used for api requests made by this command + +GLOBAL FLAGS + --json Format output as json. DESCRIPTION Create a first-generation package version in the release org. @@ -114,7 +117,7 @@ FLAG DESCRIPTIONS subscribers. ``` -_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.4/src/commands/package1/version/create.ts)_ +_See code: [src/commands/package1/version/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package1/version/create.ts)_ ## `sf package1:version:create:get` @@ -122,13 +125,16 @@ Retrieve the status of a package version creation request. ``` USAGE - $ sf package1:version:create:get -o -i [--api-version ] + $ sf package1:version:create:get -o -i [--json] [--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 + -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 + --json Format output as json. ALIASES $ sf force:package1:version:create:get @@ -143,7 +149,7 @@ EXAMPLES $ 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/1.27.4/src/commands/package1/version/create/get.ts)_ +_See code: [src/commands/package1/version/create/get.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package1/version/create/get.ts)_ ## `sf package1:version:display` @@ -151,14 +157,17 @@ Display details about a first-generation package version. ``` USAGE - $ sf package1:version:display -o -i [--api-version ] + $ sf package1:version:display -o -i [--json] [--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 + --api-version= Override the api version used for api requests made by this command + +GLOBAL FLAGS + --json Format output as json. ALIASES $ sf force:package1:version:display @@ -173,7 +182,7 @@ EXAMPLES $ 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/1.27.4/src/commands/package1/version/display.ts)_ +_See code: [src/commands/package1/version/display.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package1/version/display.ts)_ ## `sf package1:version:list` @@ -181,13 +190,16 @@ List package versions for the specified first-generation package or for the org. ``` USAGE - $ sf package1:version:list -o [--api-version ] [-i ] + $ sf package1:version:list -o [--json] [--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 + -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 + --json Format output as json. ALIASES $ sf force:package1:version:list @@ -207,7 +219,7 @@ FLAG DESCRIPTIONS 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/1.27.4/src/commands/package1/version/list.ts)_ +_See code: [src/commands/package1/version/list.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package1/version/list.ts)_ ## `sf package:create` @@ -215,8 +227,8 @@ Create a package. ``` USAGE - $ sf package:create -v -n -t Managed|Unlocked -r [--api-version ] [-d ] [-e] - [--org-dependent] [-o ] + $ sf package:create -v -n -t Managed|Unlocked -r [--json] [--api-version ] [-d + ] [-e] [--org-dependent] [-o ] FLAGS -d, --description= Description of the package. @@ -229,10 +241,13 @@ FLAGS -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 - --org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked + --api-version= Override the api version used for api requests made by this command + --org-dependent Depends on unpackaged metadata in the installation org; applies to unlocked packages only. +GLOBAL FLAGS + --json Format output as json. + DESCRIPTION Create a package. @@ -282,7 +297,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/1.27.4/src/commands/package/create.ts)_ +_See code: [src/commands/package/create.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/create.ts)_ ## `sf package:delete` @@ -290,14 +305,17 @@ Delete a package. ``` USAGE - $ sf package:delete -v -p [--api-version ] [-n] + $ sf package:delete -v -p [--json] [--api-version ] [-n] FLAGS -n, --no-prompt Don’t prompt before deleting the package. -p, --package= (required) ID (starts with 0Ho) or alias of the package to delete. -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 + --api-version= Override the api version used for api requests made by this command + +GLOBAL FLAGS + --json Format output as json. DESCRIPTION Delete a package. @@ -320,7 +338,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/1.27.4/src/commands/package/delete.ts)_ +_See code: [src/commands/package/delete.ts](https://github.com/salesforcecli/plugin-packaging/blob/1.27.5/src/commands/package/delete.ts)_ ## `sf package:install` @@ -328,8 +346,8 @@ Install a version of a package in the target org. ``` USAGE - $ sf package:install -o -p [--api-version ] [-w ] [-k ] [-b ] [-r] [-a - all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] + $ sf package:install -o -p [--json] [--api-version ] [-w ] [-k ] [-b ] + [-r] [-a all|package] [-s AllUsers|AdminsOnly] [-t DeprecateOnly|Mixed|Delete] FLAGS -a, --apex-compile=