@salesforce/plugin-packaging 1.2.1 → 1.5.0

package/messages/package_convert.md

@@ -2,12 +2,6 @@
 
 creates a second-generation package version from a first-generation package
 
-# cliLongDescription
-
-Creates a second-generation package in the Dev Hub from a first-generation package in the Dev Hub org.
-
-# help
-
 The package convert creates a new package in the Dev Hub if one does not already exist for the specified first-generation package.
 
 It then creates a new package version in the Dev Hub with contents based on the specified first-generation package.
@@ -20,7 +14,8 @@ We recommend specifying the --installationkey to protect the contents of your pa
 
 To list package version creation requests in the org, run "sfdx force:package:version:create:list".
 
-Examples:
+# examples
+
 $ sfdx force:package:convert --package 033xx0000004Gmn -k password123
 
 # package

package/messages/package_create.md

@@ -2,19 +2,14 @@
 
 create a package
 
-# cliLongDescription
-
-Creates a package.
-
-# help
-
 First, use this command to create a package. Then create a package version.
 
 If you don’t have a namespace defined in your sfdx-project.json file, use --nonamespace.
 
 Your --name value must be unique within your namespace.
 
-Examples:
+# examples
+
 $ sfdx force:package:create -n YourPackageName -t Unlocked -r force-app
 $ sfdx force:package:create -n YourPackageName -d "Your Package Descripton" -t Unlocked -r force-app
 

package/messages/package_delete.md

@@ -2,15 +2,12 @@
 
 delete a package
 
-# cliLongDescription
+Specify the ID or alias of the package you want to delete.
 
 Delete unlocked and second-generation managed packages. Before you delete a package, first delete all associated package versions.
 
-# help
-
-Specify the ID or alias of the package you want to delete.
+# examples
 
-Examples:
 $ sfdx force:package:delete -p "Your Package Alias"
 $ sfdx force:package:delete -p 0Ho...
 

package/messages/package_displayancestry.md

@@ -2,13 +2,8 @@
 
 display the ancestry tree for a 2GP managed package version
 
-# cliDescriptionLong
+# examples
 
-Displays the ancestry tree for a 2GP managed package version.
-
-# help
-
-Examples:
 $ sfdx force:package:version:displayancestry -p package_version_alias
 $ sfdx force:package:version:displayancestry -p package_version_alias --dotcode
 $ sfdx force:package:version:displayancestry -p OHo...

package/messages/package_install.md

@@ -2,17 +2,12 @@
 
 install a package in the target org
 
-# cliDescriptionLong
-
-Installs a package in the target org.
-
-# help
-
 Supply the ID of the package version to install. The package installs in your default target org unless you supply the username for a different target org.
 
 For package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgradetype value. To delete components that can be safely deleted and deprecate the others, specify --upgradetype Mixed (the default). To deprecate all removed components, specify --upgradetype DeprecateOnly. To delete all removed components, except for custom objects and custom fields, that don't have dependencies, specify --upgradetype Delete. (Note: This option can result in the loss of data that is associated with the deleted components.) The default is Mixed.
 
-Examples:
+# examples
+
 $ sfdx force:package:beta:install --package 04t... -u me@example.com
 $ sfdx force:package:beta:install --package awesome_package_alias
 $ sfdx force:package:beta:install --package "Awesome Package Alias"

package/messages/package_install_get.md

@@ -6,9 +6,8 @@ retrieve the status of a package installation request
 
 Retrieves the status of a package installation request.
 
-# help
+# examples
 
-Examples:
 $ sfdx force:package:install:get -i 0Hf...
 $ sfdx force:package:install:get -i 0Hf... -u me@example.com
 

package/messages/package_install_report.md

@@ -2,13 +2,8 @@
 
 retrieve the status of a package installation request
 
-# cliDescriptionLong
+# examples
 
-Retrieves the status of a package installation request.
-
-# help
-
-Examples:
 $ sfdx force:package:install:report -i 0Hf...
 $ sfdx force:package:install:report -i 0Hf... -u me@example.com
 

package/messages/package_install_request.md

@@ -6,9 +6,8 @@
 
 Retrieves the status of a package installion request.
 
-# help
+# examples
 
-Examples:
 $ sfdx force:package:install:get -i 0Hf...
 $ sfdx force:package:install:get -i 0Hf... -u me@example.com
 

package/messages/package_installed_list.md

@@ -2,10 +2,6 @@
 
 list the org’s installed packages
 
-# cliLongDescription
-
-Lists all packages installed in the target org.
-
 # examples
 
 $ sfdx force:package:installed:list

package/messages/package_list.md

@@ -2,15 +2,10 @@
 
 list all packages in the Dev Hub org
 
-# cliLongDescription
-
-Lists all packages in the Dev Hub org.
-
-# help
-
 You can view the namespace, IDs, and other details for each package.
 
-Examples:
+# examples
+
 $ sfdx force:package:list -v devhub@example.com
 $ sfdx force:package:list -v devhub@example.com --verbose
 

package/messages/package_uninstall.md

@@ -2,15 +2,10 @@
 
 uninstall a second-generation package from the target org
 
-# cliDescriptionLong
-
-Uninstalls a second-generation package from the target org. To uninstall a first-generation package, use the Salesforce user interface.
-
-# help
-
 Specify the package ID for a second-generation package.
 
-Examples:
+# examples
+
 $ sfdx force:package:beta:uninstall -p 04t... -u me@example.com
 $ sfdx force:package:beta:uninstall -p undesirable_package_alias
 $ sfdx force:package:beta:uninstall -p "Undesirable Package Alias"
@@ -59,10 +54,6 @@ The ID (starts with 04t) or alias of the package version to uninstall.
 
 Include either a %s value or a %s value.
 
-# invalidIdOrPackage
-
-Invalid alias or ID: %s. Either your alias is invalid or undefined, or the ID provided is invalid (must start with 04t).
-
 # InProgress
 
 PackageUninstallRequest is currently InProgress.

package/messages/package_uninstall_get.md

@@ -6,9 +6,8 @@ retrieve the status of a package uninstall request
 
 Retrieves the status of a package uninstall request.
 
-# help
+# examples
 
-Examples:
 $ sfdx force:package:uninstall:get -i 06y...
 $ sfdx force:package:uninstall:get -i 06y... -u me@example.com
 

package/messages/package_uninstall_report.md

@@ -2,13 +2,8 @@
 
 retrieve status of package uninstall request
 
-# cliDescriptionLong
+# examples
 
-Retrieves the status of a package uninstall request.
-
-# help
-
-Examples:
 $ sfdx force:package:uninstall:report -i 06y...
 $ sfdx force:package:uninstall:report -i 06y... -u me@example.com
 

package/messages/package_update.md

@@ -2,15 +2,10 @@
 
 update package details
 
-# cliLongDescription
-
-Updates details about a package. Does not create a package version.
-
-# help
-
 Specify a new value for each option you want to update.
 
-Examples:
+# examples
+
 $ sfdx force:package:update -p "Your Package Alias" -n "New Package Name"
 $ sfdx force:package:update -p 0Ho... -d "New Package Description"
 

package/messages/package_version_create_list.md

@@ -2,9 +2,11 @@
 
 list package version creation requests
 
-# cliLongDescription
+Shows the details of each request to create a package version in the Dev Hub org.
 
-Lists all requests to create second-generation package versions 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.
 
 # statusDescription
 
@@ -14,15 +16,8 @@ filter the list by version creation request status
 
 Filters the list based on the status of version creation requests.
 
-# help
-
-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.
+# examples
 
-Examples:
 $ sfdx force:package:version:create:list
 $ sfdx force:package:version:create:list --createdlastdays 3
 $ sfdx force:package:version:create:list --status Error

package/messages/package_version_create_report.md

@@ -2,15 +2,10 @@
 
 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:
+# examples
+
 $ sfdx force:package:version:create:report -i 08c...
 $ sfdx force:package:version:create:report -i 08c... -v devhub@example.com
 

package/messages/package_version_delete.md

@@ -1,16 +1,10 @@
 # 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:
+# examples
+
 $ sfdx force:package:version:delete -p "Your Package Alias"
 $ sfdx force:package:version:delete -p 04t...
 

package/messages/package_version_list.md

@@ -1,10 +1,12 @@
 # cliDescription
 
-list all package versions in the Dev Hub org
+list all package versions in the Dev Hub org.
 
-# cliLongDescription
+Displays details of each package version in the org.
 
-Lists all package versions in the Dev Hub 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
 
@@ -46,15 +48,8 @@ display extended package version details
 
 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
 
-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

package/messages/package_version_promote.md

@@ -2,15 +2,10 @@
 
 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:
+# 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"
@@ -23,7 +18,7 @@ ID (starts with 04t) or alias of the package version to promote
 
 The ID (starts with 04t) or alias of the package version to promote.
 
-# packageVersionPromoteSetAsReleasedYesNo
+# packageVersionPromoteConfirm
 
 Are you sure you want to release package version %s? You can't undo this action. Release package (y/n)?
 

package/messages/package_version_report.md

@@ -2,13 +2,8 @@
 
 retrieve details about a package version in the Dev Hub org
 
-# cliLongDescription
+# examples
 
-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"
 

package/messages/package_version_update.md

@@ -2,15 +2,10 @@
 
 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:
+# 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"