@salesforce/plugin-packaging 0.0.1 → 1.2.0

package/messages/package1_version_create.md

@@ -0,0 +1,128 @@
+# package1CliDescription
+
+develop first-generation managed and unmanaged packages
+
+# package1CliDescriptionLong
+
+Use the package1 commands to create and view first-generation package versions in your Dev Hub org.
+
+# cliDescription
+
+create a first-generation package version in the release org
+
+# cliDescriptionLong
+
+Creates a first-generation package version in the release org.
+
+# cliHelp
+
+The package version is based on the contents of the specified metadata package. Omit -m if you want to create an unmanaged package version.
+
+# id
+
+ID of the metadata package (starts with 033) of which you’re creating a new version
+
+# idLong
+
+ID of the metadata package (starts with 033) of which you’re creating a new version.
+
+# name
+
+package version name
+
+# nameLong
+
+Package version name.
+
+# description
+
+package version description
+
+# descriptionLong
+
+Package version description.
+
+# version
+
+package version in major.minor format, for example, 3.2
+
+# versionLong
+
+Package version in major.minor format, for example, 3.2.
+
+# releaseNotes
+
+release notes URL
+
+# releaseNotesLong
+
+The release notes URL. This link is displayed in the package installation UI to provide release notes for this package version to subscribers.
+
+# postInstall
+
+post install URL
+
+# postInstallLong
+
+The post-install instructions URL. The contents of the post-installation instructions URL are displayed in the UI after installation of the package version.
+
+# managedReleased
+
+create a managed package version
+
+# managedReleasedLong
+
+Creates a managed package version. To create a beta version, don’t include this parameter.
+
+# installationKey
+
+installation key for key-protected package (default: null)
+
+# installationKeyLong
+
+Installation key for creating the key-protected package. The default is null.
+
+# wait
+
+minutes to wait for the package version to be created (default: 2 minutes)
+
+# waitLong
+
+Minutes to wait for the package version to be created. The default is 2 minutes.
+
+# notANumber
+
+Field %s must contain only a numeric value: %s.
+
+# invalidVersion
+
+Version supplied, %s, is not formatted correctly. Enter in major.minor format, for example, 3.2.
+
+# timeout
+
+Stopped waiting for package upload to finish. Wait time exceeded. waitTimeInMinutes = %s.
+
+# uploadFailure
+
+Package upload failed. ${os.EOL}%s
+
+# uploadFailureDefault
+
+Package version creation failed with unknown error
+
+# package1VersionCreateHumanSuccess
+
+Successfully created package version: %s for package %s.
+
+# package1VersionCreateCommandInvalidVersion
+
+Version supplied, %s, is not formatted correctly. Enter in major.minor format, for example, 3.2.
+
+# SUCCESS
+
+Successfully uploaded package [%s]
+
+# QUEUED
+
+PackageUploadRequest has been enqueued. You can query the status using
+sfdx force:package1:beta:version:create:get -i %s -u %s

package/messages/package1_version_create_get.md

@@ -0,0 +1,31 @@
+# cliDescription
+
+retrieve the status of a package version creation request
+
+# examples
+
+Examples:
+$ sfdx force:package1:version:create:get -i 0HD...
+$ sfdx force:package1:version:create:get -i 0HD... -u devhub@example.com
+
+# requestId
+
+PackageUploadRequest ID
+
+# requestIdLong
+
+The ID of the PackageUploadRequest.
+
+# IN_PROGRESS
+
+PackageUploadRequest is still InProgress. You can query the status using
+sfdx force:package1:version:create:get -i %s -u %s
+
+# SUCCESS
+
+Successfully uploaded package [%s]
+
+# QUEUED
+
+PackageUploadRequest has been enqueued. You can query the status using
+sfdx force:package1:version:create:get -i %s -u %s

package/messages/package1_version_display.md

@@ -0,0 +1,19 @@
+# description
+
+display details about a first-generation package version
+
+# help
+
+Display detailed information about an individual package version, including metadata package ID, name, the release state, and build number.
+
+# packageId
+
+metadata package version ID (starts with 04t)
+
+# packageIdLong
+
+ID (starts with 04t) of the metadata package version whose details you want to display.
+
+# packageIdInvalid
+
+Verify that you entered a valid package version ID (starts with 04t) and try again.

package/messages/package1_version_list.md

@@ -0,0 +1,31 @@
+# longDescription
+
+Lists the versions for the specified package or all first-generation packages in the org.
+
+# cliDescription
+
+list package versions for the specified first-generation package or for the org
+
+# cliHelp
+
+If a metadata package ID is specified, lists all versions of the specified package. Otherwise, lists all package versions for the org. For each package version, the list includes the package version ID, metadata package ID, name, version number, and release state.
+
+# packageId
+
+metadata package ID (starts with 033)
+
+# packageIdLong
+
+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.
+
+# humanSuccess
+
+Successfully created the package version list.
+
+# action
+
+Verify that you entered a valid package ID and that you are authorized in the org. Then try again.
+
+# packageIdInvalid
+
+Verify that you entered a valid package version ID (starts with 033) and try again.

package/messages/package2.md

@@ -0,0 +1,87 @@
+# topicHelp
+
+develop second-generation packages
+
+# topicHelpLong
+
+Use the package2 commands to create, install, and manage second-generation 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.
+
+# invalidId
+
+Invalid %s: %s. Provide a valid ID that starts with %s.
+
+# invalidDaysNumber
+
+Provide a valid positive number for %s.
+
+# invalidStatus
+
+Invalid status '%s'. Please provide one of these statuses: %s
+
+# package2NotEnabledAction
+
+Second-generation 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.
+
+# package2InstanceNotEnabled
+
+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.
+
+# package2SourceOrgNotEnabled
+
+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.
+
+# 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 but the value found is [%s].
+
+# errorNoMatchingAncestor
+
+The ancestorId for ancestorVersion [%s] can't be found. Package 2 ID [%s].
+
+# errorAncestorIdVersionMismatch
+
+The ancestorVersion in sfdx-project.json is not the version expected for the ancestorId you supplied. ancestorVersion [%s]. ancestorID [%s].
+
+# errorpackage2AncestorIdsKeyNotSupported
+
+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.

package/messages/package2_create.md

@@ -0,0 +1,56 @@
+# cliDescription
+
+create a second-generation package
+
+# cliLongDescription
+
+Creates a second-generation package.
+
+# help
+
+First, use this command to create a second-generation package. Then create a package version.
+
+Your --name value must be unique within your namespace.
+
+Examples:
+$ sfdx force:package2:create -n PackageName -d 'My New Package' -o Unlocked
+
+Run 'sfdx force:package2:list' to list all second-generation packages in the Dev Hub org.
+
+# name
+
+package name
+
+# nameLong
+
+Name of the second-generation package to create.
+
+# description
+
+package description
+
+# descriptionLong
+
+Description of the second-generation package.
+
+# noNamespace
+
+creates the package with no namespace; available only for developer-controlled packages.
+
+# noNamespaceLong
+
+Creates the package with no namespace. Available only for developer-controlled packages. Useful when migrating an existing org to packages, but new metadata should use a namespaced package.
+
+# containerOptions
+
+[*Managed | Unlocked] container options for the package2 (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable)
+
+# containerOptionsLong
+
+Container options for the package2.
+Managed is default. Other options include Unlocked. (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable).
+These options determine the upgrade and editability rules.
+
+# humanSuccess
+
+Successfully created a second-generation package (package2).

package/messages/package2_list.md

@@ -0,0 +1,35 @@
+# cliDescription
+
+list all second-generation packages in the Dev Hub org
+
+# cliLongDescription
+
+Lists all second-generation packages in the Dev Hub org.
+
+# help
+
+You can view the namespace, IDs, and other details for each package.
+
+# namespace
+
+Namespace Prefix
+
+# name
+
+Name
+
+# id
+
+Id
+
+# package2Id
+
+Subscriber Package2 Id
+
+# description
+
+Description
+
+# containerOptions
+
+Options

package/messages/package2_update.md

@@ -0,0 +1,45 @@
+# cliDescription
+
+update a second-generation package
+
+# cliLongDescription
+
+Updates a second-generation package.
+
+# help
+
+Specify a new value for each option you want to update.
+
+Examples:
+$ sfdx force:package2:update --package2id 0Ho... --name 'AAnalytics'
+$ sfdx force:package2:update -i 0Ho... -d 'Advanced Analytics'
+
+Run 'sfdx force:package2:list' to list all second-generation packages in the Dev Hub org.
+
+# id
+
+id of the package (starts with 0Ho)
+
+# idLong
+
+ID of package (starts with 0Ho).
+
+# name
+
+package name
+
+# nameLong
+
+Name of the package to update.
+
+# description
+
+package description
+
+# descriptionLong
+
+Description of the package.
+
+# humanSuccess
+
+Successfully updated the package. ID: %s.

package/messages/package2_version_create.md

@@ -0,0 +1,149 @@
+# cliDescription
+
+create a second-generation package version
+
+# cliLongDescription
+
+Creates a second-generation package (package2) version in the Dev Hub org.
+
+# help
+
+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 package2 version ID (05i), run "sfdx force:package2:version:create:get -i 08c...".
+
+To list package version creation requests in the org, run "sfdx force:package2:version:create:list".
+
+Examples:
+$ sfdx force:package2:version:create -d common
+$ sfdx force:package2:version:create -i 0Ho... -d common
+
+# package2Id
+
+ID of the parent package (starts with 0Ho)
+
+# longPackage2Id
+
+ID of parent package (starts with 0Ho).
+
+# dir
+
+path to directory that contains the contents of the package version
+
+# longDir
+
+The path to the directory that contains the contents of the package version.
+
+# branch
+
+the package version’s branch
+
+# longBranch
+
+The package version’s branch.
+
+# tag
+
+the package version’s tag
+
+# longTag
+
+The package version’s tag.
+
+# key
+
+installation key for key-protected package (default: null)
+
+# longKey
+
+Installation key for creating the key-protected package. The default is null.
+
+# preserve
+
+temp files are preserved that would otherwise be deleted
+
+# longPreserve
+
+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
+
+# tempFileLocation
+
+The temp files are located at: %s.
+
+# wait
+
+minutes to wait for the package version to be created
+
+# longWait
+
+The number of minutes to wait for the package version to be created.
+
+# instance
+
+the instance where the package version will be created——for example, NA50
+
+# longInstance
+
+The instance where the package version will be created——for example, NA50.
+
+# sourceorg
+
+the source org ID used to copy the org shape for the build org
+
+# longSourceorg
+
+The source org ID used to copy the org shape for the build org.
+
+# InProgress
+
+Package2 version creation request is InProgress. Run "sfdx force:package2:version:create:get -i %s" to query for status.
+
+# Queued
+
+Package2 version creation request is Queued. Run "sfdx force:package2:version:create:get -i %s" to query for status.
+
+# Success
+
+Successfully created the package2 version [%s]. Package2 Version Id: %s. Subscriber Package2 Version Id: %s.
+Package Installation URL: %s%s
+As an alternative, you can use the "sfdx force:package:install" command.
+
+# errorMissingFlags
+
+Include either a %s value or a %s value. The value must match one of the packageDirectories specified in sfdx-project.json.
+
+# errorNoMatchingPackageDirectory
+
+The %s value [%s], doesn’t match the %s value in any packageDirectories specified in sfdx-project.json.
+
+# errorDirectoryIdMismatch
+
+The %s value, [%s], and %s value, [%s], were both found in sfdx-project.json but don’t match. If you supply both values, they must match the path and id values in one of the packageDirectories.
+
+# errorDependencyPair
+
+Dependency must specify either a subscriberPackageVersionId or both packageId and versionNumber: %s.
+
+# errorNoIdInHub
+
+No package2 ID was found in Dev Hub for package2 ID: %s.
+
+# errorEmptyPackageDirs
+
+sfdx-project.json must contain a packageDirectories entry for a package. It has no entries, currently.
+
+# unknownError
+
+Package2 version creation failed with unknown error.
+
+# undefinedStatus
+
+Package2 version creation returned with status: %s.

package/messages/package2_version_create_get.md

@@ -0,0 +1,34 @@
+# cliDescription
+
+retrieve a package version creation request
+
+# cliLongDescription
+
+Retrieves a second-generation 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:package2:version:create:get --package2createrequestid 08c...
+
+To show all requests in the org, run "sfdx force:package2:version:create:list".
+
+# requestId
+
+package2 version creation request ID (starts with 08c)
+
+# requestIdLong
+
+The ID of the package2 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/package2_version_create_list.md

@@ -0,0 +1,62 @@
+# cliDescription
+
+list package version creation requests
+
+# cliLongDescription
+
+Lists all requests to create second-generation package (package2) versions in the Dev Hub org.
+
+# statusDescription
+
+filter the list by version creation request status
+
+# statusLongDescription
+
+Filters the list based on the status of version creation requests.
+
+# help
+
+Shows the details of each request to create a package2 version that's run 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:package2:version:create:get" and supply the request ID.
+
+Examples:
+$ sfdx force:package2:version:create:list
+$ sfdx force:package2:version:create:list --createdlastdays 3
+$ sfdx force:package2:version:create:list --status Error
+$ sfdx force:package2:version:create:list -s InProgress
+$ sfdx force:package2:version:create:list -c 3 -s Success
+
+# id
+
+ID
+
+# status
+
+Status
+
+# package2Id
+
+Package2 Id
+
+# package2VersionId
+
+Package2 Version Id
+
+# subscriberPackageVersionId
+
+Subscriber Package2 Version Id
+
+# branch
+
+Branch
+
+# tag
+
+Tag
+
+# installUrl
+
+Installation URL

package/messages/package2_version_get.md

@@ -0,0 +1,14 @@
+# cliDescription
+
+retrieve a package version in the Dev Hub org
+
+# cliLongDescription
+
+Retrieves a package version in the Dev Hub org.
+
+# help
+
+Examples:
+$ sfdx force:package2:version:get --package2versionid 05i...
+
+To update package version values, run "sfdx force:package2:version:update".