@salesforce/plugin-packaging 1.0.0 → 1.2.1

package/messages/package_version_create_report.md

@@ -0,0 +1,35 @@
+# cliDescription
+
+retrieve details about a package version creation request
+
+# cliLongDescription
+
+Retrieves details about a package version creation request in the Dev Hub org.
+
+# help
+
+Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.
+
+Examples:
+$ sfdx force:package:version:create:report -i 08c...
+$ sfdx force:package:version:create:report -i 08c... -v devhub@example.com
+
+To show all requests in the org, run "sfdx force:package:version:create:list".
+
+# requestId
+
+package version creation request ID (starts with 08c)
+
+# requestIdLong
+
+The ID (starts with 08c) of the package version creation request you want to display.
+
+# error
+
+Error
+
+# truncatedErrors
+
+...
+
+To see all errors, run: sfdx force:data:soql:query -t -q "SELECT Message FROM Package2VersionCreateRequestError WHERE ParentRequest.Id ='%s'"

package/messages/package_version_delete.md

@@ -0,0 +1,63 @@
+# cliDescription
+
+delete a package version
+
+# cliLongDescription
+
+Delete unlocked and second-generation managed package versions.
+
+# help
+
+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
+
+ID (starts with 04t) or alias of the package to update a version of
+
+# packageLong
+
+The ID (starts with 04t) or alias of the package version to delete.
+
+# undelete
+
+undelete a deleted package version
+
+# undeleteLong
+
+Undelete a deleted package version.
+
+# noPrompt
+
+don’t prompt before deleting the package version
+
+# noPromptLong
+
+Don’t prompt before deleting the package version.
+
+# promptDelete
+
+Deleted package versions can’t be recovered.
+
+Do you want to continue? (y/n)
+
+# promptUndelete
+
+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
+
+The request to delete this package version has been canceled.
+
+# humanSuccess
+
+Successfully deleted the package version.
+
+# humanSuccessUndelete
+
+Successfully undeleted the package version.

package/messages/package_version_list.md

@@ -0,0 +1,135 @@
+# cliDescription
+
+list all package versions in the Dev Hub org
+
+# cliLongDescription
+
+Lists all package versions in the Dev Hub org.
+
+# conciseDescription
+
+display limited package version details
+
+# conciseLongDescription
+
+Displays limited package version details.
+
+# packagesDescription
+
+filter results on specified comma-delimited packages (aliases or 0Ho IDs)
+
+# packagesLongDescription
+
+Filters results on the specified comma-delimited packages (aliases or 0Ho IDs).
+
+# releasedDescription
+
+display released versions only
+
+# releasedLongDescription
+
+Displays released versions only (IsReleased=true).
+
+# orderByDescription
+
+order by the specified package version fields
+
+# orderByLongDescription
+
+Orders the list by the specified package version fields.
+
+# verboseDescription
+
+display extended package version details
+
+# verboseLongDescription
+
+Displays extended package version details.
+
+# help
+
+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).
+
+Examples:
+$ 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
+
+# name
+
+Name
+
+# description
+
+Description
+
+# version
+
+Version
+
+# id
+
+Package Version Id
+
+# alias
+
+Alias
+
+# subscriberPackageVersionId
+
+Subscriber Package Version Id
+
+# convertedFromVersionId
+
+Converted From Version Id
+
+# packageId
+
+Package Id
+
+# packageBranch
+
+Branch
+
+# packageTag
+
+Tag
+
+# installUrl
+
+Installation URL
+
+# installKey
+
+Installation Key
+
+# codeCoverage
+
+Code Coverage
+
+# hasPassedCodeCoverageCheck
+
+Code Coverage Met
+
+# validationSkipped
+
+Validation Skipped
+
+# releaseVersion
+
+Release Version
+
+# buildDurationInSeconds
+
+Build Duration in Seconds
+
+# hasMetadataRemoved
+
+Managed Metadata Removed

package/messages/package_version_promote.md

@@ -0,0 +1,50 @@
+# cliDescription
+
+promote a package version to released
+
+# cliDescriptionLong
+
+Promotes a package version to released status.
+
+# help
+
+Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.
+
+Examples:
+$ sfdx force:package:version:promote -p 04t...
+$ sfdx force:package:version:promote -p awesome_package_alias
+$ sfdx force:package:version:promote -p "Awesome Package Alias"
+
+# package
+
+ID (starts with 04t) or alias of the package version to promote
+
+# packageLong
+
+The ID (starts with 04t) or alias of the package version to promote.
+
+# packageVersionPromoteSetAsReleasedYesNo
+
+Are you sure you want to release package version %s? You can't undo this action. Release package (y/n)?
+
+# setasreleasedForce
+
+no prompt to confirm setting the package version as released
+
+# setasreleasedForceLong
+
+Do not prompt to confirm setting the package version as released.
+
+# humanSuccess
+
+Successfully promoted the package version, ID: %s, to released. Starting in Winter ‘21, only unlocked package versions that have met the minimum 75% code coverage requirement can be promoted. Code coverage minimums aren’t enforced on org-dependent unlocked packages.
+
+# previouslyReleasedMessage
+
+You already promoted a package version with this major.minor.patch version number. For a given major.minor.patch number, you can promote only one version.
+
+# previouslyReleasedAction
+
+Create a new package version with a different --versionumber, then promote the package version.
+sfdx force:package:version:create -p <name> -n <versionnum> -k <key>
+sfdx force:package:version:promote -p 05ixxx

package/messages/package_version_report.md

@@ -0,0 +1,51 @@
+# cliDescription
+
+retrieve details about a package version in the Dev Hub org
+
+# cliLongDescription
+
+Retrieves details about a package version in the Dev Hub org.
+
+# help
+
+Examples:
+$ sfdx force:package:version:report -p 04t...
+$ sfdx force:package:version:report -p "Your Package Alias"
+
+To update package version values, run "sfdx force:package:version:update".
+
+# package
+
+ID (starts with 04t) or alias of the package to retrieve details for
+
+# packageLong
+
+The ID (starts with 04t) or alias of the package to retrieve details for.
+
+# verboseDescription
+
+displays extended package version details
+
+# verboseLongDescription
+
+Displays extended package version details.
+
+# dependencies
+
+Dependencies
+
+# codeCoveragePercentages
+
+Code Coverage Details
+
+# ancestorId
+
+Ancestor
+
+# ancestorVersion
+
+Ancestor Version
+
+# isReleased
+
+Released

package/messages/package_version_update.md

@@ -0,0 +1,74 @@
+# cliDescription
+
+update a package version
+
+# cliLongDescription
+
+Updates a second-generation package version in the Dev Hub org.
+
+# help
+
+Specify a new value for each option you want to update.
+
+Examples:
+$ sfdx force:package:version:update -p "Your Package Alias" -k password123
+$ sfdx force:package:version:update -p 04t... -b main -t 'Release 1.0.7'
+$ sfdx force:package:version:update -p 04t... -e "New Package Version Description"
+
+To display details about a package version, run "sfdx force:package:version:report".
+
+# package
+
+ID (starts with 04t) or alias of the package to update a version of
+
+# packageLong
+
+The ID (starts with 04t) or alias of the package to update a version of.
+
+# name
+
+new package version name
+
+# nameLong
+
+The new package version name.
+
+# description
+
+new package version description
+
+# descriptionLong
+
+The new package version description.
+
+# branch
+
+new package version branch
+
+# branchLong
+
+The new package version branch.
+
+# tag
+
+new package version tag
+
+# tagLong
+
+The new package version tag.
+
+# key
+
+new installation key for key-protected package (default: null)
+
+# longKey
+
+The new installation key for the key-protected package. The default is null.
+
+# humanSuccess
+
+Successfully updated the package version.
+
+# previousReleased
+
+To release the new package version, run "sfdx force:package:version:update -s <new package version ID>".

package/messages/packaging.md

@@ -0,0 +1,157 @@
+# topicHelp
+
+develop, install, and manage packages
+
+# topicHelpLong
+
+Use the package commands to develop, install, and manage packages.
+
+# createdLastDaysDescription
+
+created in the last specified number of days (starting at 00:00:00 of first day to now; 0 for today)
+
+# createdLastDaysLongDescription
+
+Filters the list based on the specified maximum number of days since the request was created (starting at 00:00:00 of first day to now; 0 for today).
+
+# modifiedLastDaysDescription
+
+list items modified in the specified last number of days (starting at 00:00:00 of first day to now; 0 for today)
+
+# modifiedLastDaysLongDescription
+
+Lists the items modified in the specified last number of days, starting at 00:00:00 of first day to now. Use 0 for today.
+
+# invalidIdOrAlias
+
+The %s: %s isn't defined in the sfdx-project.json. Add it to the packageDirectories section and add the alias to packageAliases with its %s ID.
+
+# invalidDaysNumber
+
+Provide a valid positive number for %s.
+
+# invalidStatus
+
+Invalid status '%s'. Please provide one of these statuses: %s
+
+# packageNotEnabledAction
+
+Packaging is not enabled on this org. Verify that you are authenticated to the desired org and try again. Otherwise, contact Salesforce Customer Support for more information.
+
+# packageInstanceNotEnabled
+
+Your org does not have permission to specify a build instance for your package version. Verify that you are authenticated to the desired org and try again. Otherwise, contact Salesforce Customer Support for more information.
+
+# packageSourceOrgNotEnabled
+
+Your Dev Hub does not have permission to specify a source org for your build org. Verify that you are authenticated to the correct Dev Hub and try again. Otherwise, contact Salesforce Customer Support for assistance.
+
+# installStatus
+
+Waiting for the package install request to complete. Status = %s
+
+# errorMissingVersionNumber
+
+The VersionNumber property must be specified.
+
+# errorInvalidVersionNumber
+
+VersionNumber must be in the format major.minor.patch.build but the value found is [%s].
+
+# errorInvalidBuildNumber
+
+The provided VersionNumber '%s' is invalid. Provide an integer value or use the keyword '%s' for the build number.
+
+# errorInvalidBuildNumberForKeywords
+
+The provided VersionNumber '%s' is invalid. Provide an integer value or use the keyword '%s' or '%s' for the build number.
+
+# errorInvalidPatchNumber
+
+The provided VersionNumber '%s' is not supported. Provide a patch number of 0.
+
+# errorInvalidMajorMinorNumber
+
+The provided VersionNumber '%s' is invalid. Provide an integer value for the %s number.
+
+# errorInvalidAncestorVersionFormat
+
+The ancestor versionNumber must be in the format major.minor.patch but the value found is [%s].
+
+# errorNoMatchingMajorMinorForPatch
+
+Can’t create patch version. The specified package ancestor [%s] either isn’t a promoted and released version, or can’t be found. Check the specified ancestor version, and then retry creating the patch version.
+
+# errorNoMatchingAncestor
+
+The ancestorId for ancestorVersion [%s] can't be found. Package ID [%s].
+
+# errorAncestorNotReleased
+
+The ancestor package version [%s] specified in the sfdx-project.json file hasn’t been promoted and released. Release the ancestor package version before specifying it as the ancestor in a new package or patch version.
+
+# errorAncestorNotHighest
+
+Can’t create package version. The ancestor version [%s] you specified isn’t the highest released package version. Set the ancestor version to %s, and try creating the package version again. You can also specify --skipancestorcheck to override the ancestry requirement.
+
+# errorAncestorNoneNotAllowed
+
+Can’t create package version because you didn’t specify a package ancestor. Set the ancestor version to %s, and try creating the package version. You can also specify --skipancestorcheck to override the ancestry requirement.
+
+# errorAncestorIdVersionMismatch
+
+Can’t create package version. The ancestorVersion listed in your sfdx-project.json file doesn’t map to this package. Ensure the ancestor ID is correct, or set the ID to ancestorID:HIGHEST to ensure the highest released package version is used as the ancestor. Then try creating the package version again.
+
+# errorAncestorIdVersionHighestOrNoneMismatch
+
+Can’t create package version. The ancestorId [%s] and ancestorVersion [%s] in your sfdx-project.json file don’t map to the same package version. Remove the incorrect entry, and try creating the package version again.
+
+# errorpackageAncestorIdsKeyNotSupported
+
+The package2AncestorIds key is no longer supported in a scratch org definition. Ancestors defined in sfdx-project.json will be included in the scratch org.
+
+# errorInvalidIdNoMatchingVersionId
+
+The %s %s is invalid, as a corresponding %s was not found
+
+# errorIdTypeMismatch
+
+ID type mismatch: an ID of type %s is required, but an ID of type %s was specified: %s
+
+# updatedSfProject
+
+sfdx-project.json has been updated.
+
+# errorSfProjectFileWrite
+
+sfdx-project.json could not be updated with the following entry for this package:
+%s
+Reason: %s
+
+# invalidPackageTypeAction
+
+Specify Unlocked or Managed for package type.
+
+# invalidPackageTypeMessage
+
+Invalid package type
+
+# idNotFoundAction
+
+It`s possible that this package was created on a different Dev Hub. Authenticate to the Dev Hub org that owns the package, and reference that Dev Hub when running the command.
+
+# malformedPackageVersionIdAction
+
+Use "sfdx force:package:version:list" to verify the 05i package version ID.
+
+# malformedPackageVersionIdMessage
+
+We can’t find this package version ID for this Dev Hub.
+
+# malformedPackageIdAction
+
+Use "sfdx force:package:list" to verify the 0Ho package version ID.
+
+# malformedPackageIdMessage
+
+We can’t find this package ID for this Dev Hub.