@salesforce/plugin-packaging 1.12.3 → 1.12.4

package/messages/package_version_create.md

@@ -1,215 +1,175 @@
-# cliDescription
+# summary
 
-create a package version
+Create a package version in the Dev Hub org.
 
-# cliLongDescription
-
-Creates a package version in the Dev Hub org.
+# description
 
 The package version is based on the package contents in the specified directory.
 
-To retrieve details about a package version create request, including status and package version ID (04t), run "sfdx force:package:version:create:report -i 08c...".
-
-We recommend that you specify the --installationkey parameter to protect the contents of your package and to prevent unauthorized installation of your package.
+To retrieve details about a package version create request, including status and package version ID (04t), run "<%= config.bin %> package version create report -i 08c...".
 
-To list package version creation requests in the org, run "sfdx force:package:version:create:list".
+We recommend that you specify the --installation-key parameter to protect the contents of your package and to prevent unauthorized installation of your package.
 
-To promote a package version to released, you must use the --codecoverage parameter. The package must also meet the code coverage requirements. This requirement applies to both managed and unlocked packages.
+To list package version creation requests in the org, run "<%= config.bin %> package version create list".
+To promote a package version to released, you must use the --code-coverage parameter. The package must also meet the code coverage requirements. This requirement applies to both managed and unlocked packages.
 
-We don’t calculate code coverage for org-dependent unlocked packages, or for package versions that specify --skipvalidation.
+We don’t calculate code coverage for org-dependent unlocked packages, or for package versions that specify --skip-validation.
 
 # examples
 
-$ sfdx force:package:version:create -d common -k password123
-$ sfdx force:package:version:create -p "Your Package Alias" -k password123
-$ sfdx force:package:version:create -p 0Ho... -k password123
-$ sfdx force:package:version:create -d common -k password123 --skipvalidation
+- Create a package version from the contents of the "common" directory and give it an installation key of "password123"; uses your default Dev Hub org:
 
-# package
+  <%= config.bin %> <%= command.id %> --path common --installation-key password123
 
-ID (starts with 0Ho) or alias of the package to create a version of
+- Create a package version from a package with the specified alias; uses the Dev Hub org with username devhub@example.com:
 
-# longPackage
+  <%= config.bin %> <%= command.id %> --package "Your Package Alias" --installation-key password123 --target-hub-org devhub@example.com
 
-The ID (starts with 0Ho) or alias of the package to create a version of.
+- Create a package version from a package with the specified ID:
 
-# path
+  <%= config.bin %> <%= command.id %> --package 0Ho... --installation-key password123
 
-path to directory that contains the contents of the package
+- Create a package version and skip the validation step:
 
-# longPath
+  <%= config.bin %> <%= command.id %> --path common --installation-key password123 --skip-validation
 
-The path to the directory that contains the contents of the package.
+# flags.package.summary
 
-# definitionfile
+ID (starts with 0Ho) or alias of the package to create a version of.
 
-path to a definition file similar to scratch org definition file that contains the list of features and org preferences that the metadata of the package version depends on
+# flags.path.summary
 
-# longDefinitionfile
+Path to the directory that contains the contents of the package.
 
-The path to a definition file similar to scratch org definition file that contains the list of features and org preferences that the metadata of the package version depends on.
+# flags.definition-file.summary
 
-# branch
+Path to a definition file similar to scratch org definition file that contains the list of features and org preferences that the metadata of the package version depends on.
 
-the package version’s branch
-
-# longBranch
+# flags.branch.summary
 
 Name of the branch in your source control system that the package version is based on.
 
-# tag
-
-the package version’s tag
-
-# longTag
-
-The package version’s tag.
-
-# key
+# flags.tag.summary
 
-installation key for key-protected package (either --installationkey or --installationkeybypass is required)
+Package version’s tag.
 
-# longKey
+# flags.installation-key.summary
 
-Installation key for creating the key-protected package. Either an --installationkey value or the --installationkeybypass flag is required.
+Installation key for key-protected package. (either --installation-key or --installation-key-bypass is required)
 
-# keyBypass
+# flags.installation-key-bypass.summary
 
-bypass the installation key requirement (either --installationkey or --installationkeybypass is required)
+Bypass the installation key requirement. (either --installation-key or --installation-key-bypass is required)
 
-# longKeyBypass
+# flags.installation-key-bypass.description
 
-Bypasses the installation key requirement. If you bypass this requirement, anyone can install your package. Either an --installationkey value or the --installationkeybypass flag is required.
+If you bypass this requirement, anyone can install your package.
 
-# preserve
+# flags.preserve.summary
 
-temp files are preserved that would otherwise be deleted
+Preserve temp files that would otherwise be deleted.
 
-# longPreserve
+# flags.validate-schema.summary
 
-Specifies that the temp files are preserved that would otherwise be deleted
-
-# validateschema
-
-sfdx-project.json is validated against JSON schema
-
-# longValidateschema
-
-Specifies that the sfdx-project.json file should be validated against JSON schema.
+Validate the sfdx-project.json file against the JSON schema.
 
 # tempFileLocation
 
 The temp files are located at: %s.
 
-# wait
-
-minutes to wait for the package version to be created
-
-# longWait
+# flags.wait.summary
 
-The number of minutes to wait for the package version to be created.
+Number of minutes to wait for the package version to be created.
 
-# instance
+# flags.build-instance.summary
 
-the instance where the package version will be created——for example, NA50
+Instance where the package version will be created, such as NA50.
 
-# longInstance
+# flags.version-name.summary
 
-The instance where the package version will be created——for example, NA50.
+Name of the package version to be created; overrides the sfdx-project.json value.
 
-# versionname
+# flags.version-number.summary
 
-the name of the package version to be created
+Version number of the package version to be created; overrides the sfdx-project.json value.
 
-# longVersionname
+# flags.version-description.summary
 
-The name of the package version to be created. Overrides the sfdx-project.json value.
+Description of the package version to be created; overrides the sfdx-project.json value.
 
-# versionnumber
+# flags.code-coverage.summary
 
-the version number of the package version to be created
+Calculate and store the code coverage percentage by running the packaged Apex tests included in this package version.
 
-# longVersionnumber
+# flags.code-coverage.description
 
-The version number of the package version to be created. Overrides the sfdx-project.json value.
+Before you can promote and release a managed or unlocked package version, the Apex code must meet a minimum 75% code coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions that specify --skip-validation.
 
-# versiondescription
+# flags.releasenotes-url.summary
 
-the description of the package version to be created
+Release notes URL.
 
-# longVersiondescription
+# flags.releasenotes-url.description
 
-The description of the package version to be created. Overrides the sfdx-project.json value.
+This link is displayed in the package installation UI to provide release notes for this package version to subscribers.
 
-# codeCoverage
+# flags.skip-validation.summary
 
-calculate the code coverage by running the packaged Apex tests
+Skip validation during package version creation; you can’t promote unvalidated package versions.
 
-# longCodeCoverage
+# flags.skip-validation.description
 
-Calculate and store the code coverage percentage by running the Apex tests included in this package version. Before you can promote and release a managed or unlocked package version, the Apex code must meet a minimum 75% code coverage requirement. We don’t calculate code coverage for org-dependent unlocked packages or for package versions that specify --skipvalidation.
-
-# releaseNotesUrl
-
-release notes URL
-
-# releaseNotesUrlLong
-
-The release notes URL. This link is displayed in the package installation UI to provide release notes for this package version to subscribers.
-
-# skipValidation
-
-skip validation during package version creation; you can’t promote unvalidated package versions
+Skips validation of dependencies, package ancestors, and metadata during package version creation. Skipping validation reduces the time it takes to create a new package version, but you can promote only validated package versions. Skipping validation can suppress important errors that can surface at a later stage. You can specify skip validation or code coverage, but not both. Code coverage is calculated during validation.
 
-# skipValidationLong
+# skip-validation-warning
 
-Skips validation of dependencies, package ancestors, and metadata during package version creation. Skipping validation reduces the time it takes to create a new package version, but you can promote only validated package versions. Skipping validation can suppress important errors that can surface at a later stage. You can specify skip validation or code coverage, but not both. Code coverage is calculated during validation.
+Skipping validation suppresses errors that usually surface during package version creation. Instead, these errors surface at a later stage, such as installation or post-installation. If you encounter errors that are difficult to debug, retry package version creation without the --skip-validation parameter.
 
-# skipValidationWarning
+# flags.skip-ancestor-check.summary
 
-Skipping validation suppresses errors that usually surface during package version creation. Instead, these errors surface at a later stage, such as installation or post-installation. If you encounter errors that are difficult to debug, retry package version creation without the skipvalidation parameter.
+Overrides ancestry requirements, which allows you to specify a package ancestor that isn’t the highest released package version.
 
-# skipAncestorCheck
+# flags.post-install-url.summary
 
-Overrides ancestry requirements.
+Post-install instructions URL.
 
-# skipAncestorCheckLong
+# flags.post-install-url.description
 
-Override ancestry requirements, which allows you to specify a package ancestor that isn’t the highest released package version.
+The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.
 
-# postInstallUrl
+# flags.post-install-script.summary
 
-post-install URL
+Name of the post-install script; applies to managed packages only.
 
-# postInstallUrlLong
+# flags.post-install-script.description
 
-The post-install instructions URL. The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.
+The post-install script is an Apex class within this package that is run in the installing org after installations or upgrades of this package version.
 
-# postInstallScript
+# flags.uninstall-script.summary
 
-post-install script name; managed packages only
+Uninstall script name; applies to managed packages only.
 
-# postInstallScriptLong
+# flags.uninstall-script.description
 
-Applies to managed packages only. The post-install script name. The post-install script is an Apex class within this package that is run in the installing org after installations or upgrades of this package version.
+The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of this package.
 
-# uninstallScript
+# flags.language.summary
 
-uninstall script name; managed packages only
+Language for the package.
 
-# uninstallScriptLong
+# flags.language.description
 
-Applies to managed packages only. The uninstall script name. The uninstall script is an Apex class within this package that is run in the installing org after uninstallations of this package.
+Specify the language using a language code listed under "Supported Languages" in Salesforce Help. If no language is specified, the language defaults to the language of the Dev Hub user who created the package.
 
 # InProgress
 
-Package version creation request status is '%s'. Run "sfdx force:package:version:create:report -i %s" to query for status.
+Package version creation request status is '%s'. Run "%s package:version:create:report -i %s" to query for status.
 
 # Success
 
 Successfully created the package version [%s]. Subscriber Package Version Id: %s
 Package Installation URL: %s%s
-As an alternative, you can use the "sfdx force:package:install" command.
+As an alternative, you can use the "%s package:install" command.
 
 # errorPathNotFound
 
@@ -231,14 +191,6 @@ Version create.
 
 Create version status: %s
 
-# language
-
-The language for the package. Only applies to orgs running API version 57.0 or higher.
-
-# languageLong
-
-The language for the package. Specify the language using a language code listed under "Supported Languages" in Salesforce Help.
-
-If no language is specified, the language defaults to the language of the Dev Hub user who created the package.
+# unknownError
 
-Only applies to orgs running API version 57.0 or higher.
+An unknown error occurred.

package/messages/package_version_create_list.md

@@ -1,28 +1,40 @@
-# cliDescription
+# summary
 
-list package version creation requests
+List package version creation requests.
+
+# description
 
 Shows the details of each request to create a package version in the Dev Hub org.
 
 All filter parameters are applied using the AND logical operator (not OR).
 
-To get information about a specific request, run "sfdx force:package:version:create:report" and supply the request ID.
+To get information about a specific request, run "<%= config.bin %> package version create report" and supply the request ID.
 
-# statusDescription
+# flags.status.summary
 
-filter the list by version creation request status
+Status of the version creation request, used to filter the list.
 
-# statusLongDescription
+# examples
 
-Filters the list based on the status of version creation requests.
+- List all package version creation requests in your default Dev Hub org:
 
-# examples
+  <%= config.bin %> <%= command.id %>
+
+- List package version creation 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-hub-org
+
+- List package version creation requests with status Error:
+
+  <%= config.bin %> <%= command.id %> --status Error
+
+- List package version creation requests with status InProgress:
+
+  <%= config.bin %> <%= command.id %> --status InProgress
+
+- List package version creation requests with status Success that were created today:
 
-$ sfdx force:package:version:create:list
-$ sfdx force:package:version:create:list --createdlastdays 3
-$ sfdx force:package:version:create:list --status Error
-$ sfdx force:package:version:create:list -s InProgress
-$ sfdx force:package:version:create:list -c 3 -s Success
+  <%= config.bin %> <%= command.id %> --created-last-days 0 --status Success
 
 # id
 
@@ -32,7 +44,7 @@ ID
 
 Status
 
-# packageId
+# package-id
 
 Package Id
 

package/messages/package_version_create_report.md

@@ -1,26 +1,29 @@
-# cliDescription
+# summary
 
-retrieve details about a package version creation request
+Retrieve details about a package version creation request.
+
+# description
 
 Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.
 
-To show all requests in the org, run "sfdx force:package:version:create:list".
+To show all requests in the org, run "<%= config.bin %> package version create list".
 
 # examples
 
-$ sfdx force:package:version:create:report -i 08c...
-$ sfdx force:package:version:create:report -i 08c... -v devhub@example.com
+- Retrieve details about the package version creation request with the specified ID; uses your default Dev Hub org:
+
+  <%= config.bin %> <%= command.id %> --package-create-request-id 08c...
 
-# requestId
+- Retrieve details about the specified package version creation request in the Dev Hub org with username devhub@example.com:
 
-package version creation request ID (starts with 08c)
+  <%= config.bin %> <%= command.id %> --package-create-request-id 08c... --target-hub-org devhub@example.com
 
-# requestIdLong
+# flags.package-create-request-id.summary
 
-The ID (starts with 08c) of the package version creation request you want to display.
+ID (starts with 08c) of the package version creation request you want to display.
 
 # truncatedErrors
 
 ...
 
-To see all errors, run: sfdx force:data:soql:query -t -q "SELECT Message FROM Package2VersionCreateRequestError WHERE ParentRequest.Id='%s'" -u %s
+To see all errors, run: %s data:soql:query -t -q "SELECT Message FROM Package2VersionCreateRequestError WHERE ParentRequest.Id='%s'" -o %s

package/messages/package_version_delete.md

@@ -1,46 +1,46 @@
-# cliDescription
+# summary
+
+Delete a package version.
+
+# description
 
-delete a package version
 Specify the ID or alias of the package version you want to delete.
 
 # examples
 
-$ sfdx force:package:version:delete -p "Your Package Alias"
-$ sfdx force:package:version:delete -p 04t...
-
-# package
+- Delete a package version with the specified alias using your default Dev Hub org:
 
-ID (starts with 04t) or alias of the package to update a version of
+  <%= config.bin %> <%= command.id %> --package "Your Package Alias"
 
-# packageLong
+- Delete a package version with the specified ID using the Dev Hub org with username "devhub@example.com":
 
-The ID (starts with 04t) or alias of the package version to delete.
+  <%= config.bin %> <%= command.id %> --package 04t... --target-org devhub@example.com
 
-# undelete
+# flags.package.summary
 
-undelete a deleted package version
+ID (starts with 04t) or alias of the package version to delete.
 
-# undeleteLong
+# flags.undelete.summary
 
 Undelete a deleted package version.
 
-# noPrompt
+# flags.no-prompt.summary
 
-don’t prompt before deleting the package version
+Don’t prompt before deleting the package version.
 
-# promptDelete
+# prompt-delete
 
 Deleted package versions can’t be recovered.
 
 Do you want to continue? (y/n)
 
-# promptUndelete
+# prompt-undelete
 
 This will undelete the package version, which may result in unintended consequences for customers. Proceed with caution.
 
 Do you want to continue? (y/n)
 
-# promptDeleteDeny
+# prompt-delete-deny
 
 The request to delete this package version has been canceled.
 

package/messages/package_version_list.md

@@ -1,61 +1,58 @@
-# cliDescription
+# summary
 
-list all package versions in the Dev Hub org.
+List all package versions in the Dev Hub org.
 
-Displays details of each package version in the org.
+# description
 
-Use --concise or --verbose to display limited or additional details, respectively.
+The command displays details of each package version in the org. Use --concise or --verbose to display limited or additional details, respectively.
 
 All filter parameters are applied using the AND logical operator (not OR).
 
-# conciseDescription
+# flags.concise.summary
+
+Display limited package version details.
 
-display limited package version details
+# flags.packages.summary
 
-# conciseLongDescription
+Comma-delimited list of packages (aliases or 0Ho IDs) to list.
 
-Displays limited package version details.
+# flags.released.summary
 
-# packagesDescription
+Display released versions only (IsReleased=true).
 
-filter results on specified comma-delimited packages (aliases or 0Ho IDs)
+# flags.order-by.summary
 
-# packagesLongDescription
+Package version fields used to order the list.
 
-Filters results on the specified comma-delimited packages (aliases or 0Ho IDs).
+# flags.verbose.summary
 
-# releasedDescription
+Display extended package version details.
 
-display released versions only
+# examples
 
-# releasedLongDescription
+- List package versions in your default Dev Hub org that were created in the last 3 days; show only the released versions and order the list using the PatchVersion field. Display extended details about each package version:
 
-Displays released versions only (IsReleased=true).
+  <%= config.bin %> <%= command.id %> --verbose --created-last-days 3 --released --order-by PatchVersion
 
-# orderByDescription
+- List the released package versions for the two specified packages that were modified today; use the Dev Hub org with username devhub@example.com:
 
-order by the specified package version fields
+  <%= config.bin %> <%= command.id %> --packages 0Ho000000000000,0Ho000000000001 --released --modified-last-days 0 --target-hub-org devhub@example.com
 
-# orderByLongDescription
+- List all released package versions in your default Dev Hub org:
 
-Orders the list by the specified package version fields.
+  <%= config.bin %> <%= command.id %> --released
 
-# verboseDescription
+- List package versions that were modified today in your default Dev Hub org; show limited details about each one:
 
-display extended package version details
+  <%= config.bin %> <%= command.id %> --concise --modified-last-days 0
 
-# verboseLongDescription
+- List released package versions that were created in the last 3 days in your default Dev Hub org; show limited details:
 
-Displays extended package version details.
+  <%= config.bin %> <%= command.id %> --concise --created-last-days 3 --released
 
-# examples
+- List released package versions that were modified today for the two packages with specified aliases in your default Dev Hub org:
 
-$ sfdx force:package:version:list --verbose --createdlastdays 3 --released --orderby PatchVersion
-$ sfdx force:package:version:list --packages 0Ho000000000000,0Ho000000000001 --released --modifiedlastdays 0
-$ sfdx force:package:version:list --released
-$ sfdx force:package:version:list --concise --modifiedlastdays 0
-$ sfdx force:package:version:list --concise -c 3 -r
-$ sfdx force:package:version:list --packages exp-mgr,exp-mgr-util --released --modifiedlastdays 0
+  <%= config.bin %> <%= command.id %> --packages exp-mgr,exp-mgr-util --released --modified-last-days 0
 
 # name
 
@@ -85,7 +82,7 @@ Subscriber Package Version Id
 
 Converted From Version Id
 
-# packageId
+# package-id
 
 Package Id