@salesforce/plugin-packaging 1.2.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/CHANGELOG.md +2 -1
  2. package/README.md +136 -2
  3. package/lib/commands/force/package/beta/convert.d.ts +1 -3
  4. package/lib/commands/force/package/beta/convert.js +2 -1
  5. package/lib/commands/force/package/beta/convert.js.map +1 -1
  6. package/lib/commands/force/package/beta/create.d.ts +1 -2
  7. package/lib/commands/force/package/beta/create.js +2 -1
  8. package/lib/commands/force/package/beta/create.js.map +1 -1
  9. package/lib/commands/force/package/beta/delete.d.ts +1 -2
  10. package/lib/commands/force/package/beta/delete.js +2 -1
  11. package/lib/commands/force/package/beta/delete.js.map +1 -1
  12. package/lib/commands/force/package/beta/install/report.d.ts +1 -2
  13. package/lib/commands/force/package/beta/install/report.js +2 -1
  14. package/lib/commands/force/package/beta/install/report.js.map +1 -1
  15. package/lib/commands/force/package/beta/install.d.ts +1 -1
  16. package/lib/commands/force/package/beta/install.js +2 -0
  17. package/lib/commands/force/package/beta/install.js.map +1 -1
  18. package/lib/commands/force/package/beta/list.d.ts +1 -2
  19. package/lib/commands/force/package/beta/list.js +2 -1
  20. package/lib/commands/force/package/beta/list.js.map +1 -1
  21. package/lib/commands/force/package/beta/uninstall/report.d.ts +1 -2
  22. package/lib/commands/force/package/beta/uninstall/report.js +2 -1
  23. package/lib/commands/force/package/beta/uninstall/report.js.map +1 -1
  24. package/lib/commands/force/package/beta/uninstall.d.ts +1 -0
  25. package/lib/commands/force/package/beta/uninstall.js +2 -0
  26. package/lib/commands/force/package/beta/uninstall.js.map +1 -1
  27. package/lib/commands/force/package/beta/update.d.ts +1 -2
  28. package/lib/commands/force/package/beta/update.js +2 -1
  29. package/lib/commands/force/package/beta/update.js.map +1 -1
  30. package/lib/commands/force/package/beta/version/create/list.d.ts +1 -3
  31. package/lib/commands/force/package/beta/version/create/list.js +2 -1
  32. package/lib/commands/force/package/beta/version/create/list.js.map +1 -1
  33. package/lib/commands/force/package/beta/version/create/report.d.ts +1 -1
  34. package/lib/commands/force/package/beta/version/create/report.js +3 -1
  35. package/lib/commands/force/package/beta/version/create/report.js.map +1 -1
  36. package/lib/commands/force/package/beta/version/delete.d.ts +1 -2
  37. package/lib/commands/force/package/beta/version/delete.js +3 -2
  38. package/lib/commands/force/package/beta/version/delete.js.map +1 -1
  39. package/lib/commands/force/package/beta/version/displayancestry.d.ts +1 -3
  40. package/lib/commands/force/package/beta/version/displayancestry.js +2 -2
  41. package/lib/commands/force/package/beta/version/displayancestry.js.map +1 -1
  42. package/lib/commands/force/package/beta/version/list.d.ts +1 -3
  43. package/lib/commands/force/package/beta/version/list.js +2 -1
  44. package/lib/commands/force/package/beta/version/list.js.map +1 -1
  45. package/lib/commands/force/package/beta/version/promote.d.ts +3 -3
  46. package/lib/commands/force/package/beta/version/promote.js +34 -3
  47. package/lib/commands/force/package/beta/version/promote.js.map +1 -1
  48. package/lib/commands/force/package/beta/version/report.d.ts +1 -3
  49. package/lib/commands/force/package/beta/version/report.js +2 -2
  50. package/lib/commands/force/package/beta/version/report.js.map +1 -1
  51. package/lib/commands/force/package/beta/version/update.d.ts +1 -2
  52. package/lib/commands/force/package/beta/version/update.js +2 -1
  53. package/lib/commands/force/package/beta/version/update.js.map +1 -1
  54. package/lib/commands/force/package1/beta/version/create/get.js +1 -4
  55. package/lib/commands/force/package1/beta/version/create/get.js.map +1 -1
  56. package/messages/package1_version_create_get.md +5 -1
  57. package/messages/package2_create.md +2 -1
  58. package/messages/package2_update.md +2 -1
  59. package/messages/package2_version_create.md +2 -1
  60. package/messages/package2_version_create_get.md +2 -1
  61. package/messages/package2_version_create_list.md +2 -1
  62. package/messages/package2_version_get.md +1 -2
  63. package/messages/package2_version_list.md +2 -1
  64. package/messages/package2_version_update.md +2 -1
  65. package/messages/package_convert.md +2 -1
  66. package/messages/package_create.md +2 -1
  67. package/messages/package_delete.md +2 -1
  68. package/messages/package_displayancestry.md +1 -2
  69. package/messages/package_install.md +2 -1
  70. package/messages/package_install_get.md +1 -2
  71. package/messages/package_install_report.md +1 -2
  72. package/messages/package_install_request.md +1 -2
  73. package/messages/package_list.md +2 -1
  74. package/messages/package_uninstall.md +2 -1
  75. package/messages/package_uninstall_get.md +1 -2
  76. package/messages/package_uninstall_report.md +1 -2
  77. package/messages/package_update.md +2 -1
  78. package/messages/package_version_create_list.md +2 -1
  79. package/messages/package_version_create_report.md +2 -1
  80. package/messages/package_version_delete.md +2 -1
  81. package/messages/package_version_list.md +2 -1
  82. package/messages/package_version_promote.md +3 -2
  83. package/messages/package_version_report.md +1 -2
  84. package/messages/package_version_update.md +2 -1
  85. package/oclif.manifest.json +1 -1
  86. package/package.json +3 -3
  87. package/messages/default.md +0 -1127
  88. package/messages/messages.json +0 -22
@@ -54,7 +54,8 @@ Use --concise or --verbose to display limited or additional details, respectivel
54
54
 
55
55
  All filter parameters are applied using the AND logical operator (not OR).
56
56
 
57
- Examples:
57
+ # examples
58
+
58
59
  $ sfdx force:package2:version:list --verbose --createdlastdays 3 --released --orderby PatchVersion
59
60
  $ sfdx force:package2:version:list --package2ids 0Ho000000000000,0Ho000000000001 --released --modifiedlastdays 0
60
61
  $ sfdx force:package2:version:list --released
@@ -10,7 +10,8 @@ Updates a second-generation package version in the Dev Hub org.
10
10
 
11
11
  Specify a new value for each option you want to update.
12
12
 
13
- Examples:
13
+ # examples
14
+
14
15
  $ sfdx force:package2:version:update --package2versionid 05i... --setasreleased
15
16
  $ sfdx force:package2:version:update -i 05i... -b master -t 'Release 1.0.7'
16
17
 
@@ -20,7 +20,8 @@ We recommend specifying the --installationkey to protect the contents of your pa
20
20
 
21
21
  To list package version creation requests in the org, run "sfdx force:package:version:create:list".
22
22
 
23
- Examples:
23
+ # examples
24
+
24
25
  $ sfdx force:package:convert --package 033xx0000004Gmn -k password123
25
26
 
26
27
  # package
@@ -14,7 +14,8 @@ If you don’t have a namespace defined in your sfdx-project.json file, use --no
14
14
 
15
15
  Your --name value must be unique within your namespace.
16
16
 
17
- Examples:
17
+ # examples
18
+
18
19
  $ sfdx force:package:create -n YourPackageName -t Unlocked -r force-app
19
20
  $ sfdx force:package:create -n YourPackageName -d "Your Package Descripton" -t Unlocked -r force-app
20
21
 
@@ -10,7 +10,8 @@ Delete unlocked and second-generation managed packages. Before you delete a pack
10
10
 
11
11
  Specify the ID or alias of the package you want to delete.
12
12
 
13
- Examples:
13
+ # examples
14
+
14
15
  $ sfdx force:package:delete -p "Your Package Alias"
15
16
  $ sfdx force:package:delete -p 0Ho...
16
17
 
@@ -6,9 +6,8 @@ display the ancestry tree for a 2GP managed package version
6
6
 
7
7
  Displays the ancestry tree for a 2GP managed package version.
8
8
 
9
- # help
9
+ #examples
10
10
 
11
- Examples:
12
11
  $ sfdx force:package:version:displayancestry -p package_version_alias
13
12
  $ sfdx force:package:version:displayancestry -p package_version_alias --dotcode
14
13
  $ sfdx force:package:version:displayancestry -p OHo...
@@ -12,7 +12,8 @@ Supply the ID of the package version to install. The package installs in your de
12
12
 
13
13
  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.
14
14
 
15
- Examples:
15
+ # examples
16
+
16
17
  $ sfdx force:package:beta:install --package 04t... -u me@example.com
17
18
  $ sfdx force:package:beta:install --package awesome_package_alias
18
19
  $ sfdx force:package:beta:install --package "Awesome Package Alias"
@@ -6,9 +6,8 @@ retrieve the status of a package installation request
6
6
 
7
7
  Retrieves the status of a package installation request.
8
8
 
9
- # help
9
+ #examples
10
10
 
11
- Examples:
12
11
  $ sfdx force:package:install:get -i 0Hf...
13
12
  $ sfdx force:package:install:get -i 0Hf... -u me@example.com
14
13
 
@@ -6,9 +6,8 @@ retrieve the status of a package installation request
6
6
 
7
7
  Retrieves the status of a package installation request.
8
8
 
9
- # help
9
+ # examples
10
10
 
11
- Examples:
12
11
  $ sfdx force:package:install:report -i 0Hf...
13
12
  $ sfdx force:package:install:report -i 0Hf... -u me@example.com
14
13
 
@@ -6,9 +6,8 @@
6
6
 
7
7
  Retrieves the status of a package installion request.
8
8
 
9
- # help
9
+ #examples
10
10
 
11
- Examples:
12
11
  $ sfdx force:package:install:get -i 0Hf...
13
12
  $ sfdx force:package:install:get -i 0Hf... -u me@example.com
14
13
 
@@ -10,7 +10,8 @@ Lists all packages in the Dev Hub org.
10
10
 
11
11
  You can view the namespace, IDs, and other details for each package.
12
12
 
13
- Examples:
13
+ # examples
14
+
14
15
  $ sfdx force:package:list -v devhub@example.com
15
16
  $ sfdx force:package:list -v devhub@example.com --verbose
16
17
 
@@ -10,7 +10,8 @@ Uninstalls a second-generation package from the target org. To uninstall a first
10
10
 
11
11
  Specify the package ID for a second-generation package.
12
12
 
13
- Examples:
13
+ # examples
14
+
14
15
  $ sfdx force:package:beta:uninstall -p 04t... -u me@example.com
15
16
  $ sfdx force:package:beta:uninstall -p undesirable_package_alias
16
17
  $ sfdx force:package:beta:uninstall -p "Undesirable Package Alias"
@@ -6,9 +6,8 @@ retrieve the status of a package uninstall request
6
6
 
7
7
  Retrieves the status of a package uninstall request.
8
8
 
9
- # help
9
+ #examples
10
10
 
11
- Examples:
12
11
  $ sfdx force:package:uninstall:get -i 06y...
13
12
  $ sfdx force:package:uninstall:get -i 06y... -u me@example.com
14
13
 
@@ -6,9 +6,8 @@ retrieve status of package uninstall request
6
6
 
7
7
  Retrieves the status of a package uninstall request.
8
8
 
9
- # help
9
+ #examples
10
10
 
11
- Examples:
12
11
  $ sfdx force:package:uninstall:report -i 06y...
13
12
  $ sfdx force:package:uninstall:report -i 06y... -u me@example.com
14
13
 
@@ -10,7 +10,8 @@ Updates details about a package. Does not create a package version.
10
10
 
11
11
  Specify a new value for each option you want to update.
12
12
 
13
- Examples:
13
+ # examples
14
+
14
15
  $ sfdx force:package:update -p "Your Package Alias" -n "New Package Name"
15
16
  $ sfdx force:package:update -p 0Ho... -d "New Package Description"
16
17
 
@@ -22,7 +22,8 @@ All filter parameters are applied using the AND logical operator (not OR).
22
22
 
23
23
  To get information about a specific request, run "sfdx force:package:version:create:report" and supply the request ID.
24
24
 
25
- Examples:
25
+ # examples
26
+
26
27
  $ sfdx force:package:version:create:list
27
28
  $ sfdx force:package:version:create:list --createdlastdays 3
28
29
  $ sfdx force:package:version:create:list --status Error
@@ -10,7 +10,8 @@ Retrieves details about a package version creation request in the Dev Hub org.
10
10
 
11
11
  Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.
12
12
 
13
- Examples:
13
+ # examples
14
+
14
15
  $ sfdx force:package:version:create:report -i 08c...
15
16
  $ sfdx force:package:version:create:report -i 08c... -v devhub@example.com
16
17
 
@@ -10,7 +10,8 @@ Delete unlocked and second-generation managed package versions.
10
10
 
11
11
  Specify the ID or alias of the package version you want to delete.
12
12
 
13
- Examples:
13
+ # examples
14
+
14
15
  $ sfdx force:package:version:delete -p "Your Package Alias"
15
16
  $ sfdx force:package:version:delete -p 04t...
16
17
 
@@ -54,7 +54,8 @@ Use --concise or --verbose to display limited or additional details, respectivel
54
54
 
55
55
  All filter parameters are applied using the AND logical operator (not OR).
56
56
 
57
- Examples:
57
+ # examples
58
+
58
59
  $ sfdx force:package:version:list --verbose --createdlastdays 3 --released --orderby PatchVersion
59
60
  $ sfdx force:package:version:list --packages 0Ho000000000000,0Ho000000000001 --released --modifiedlastdays 0
60
61
  $ sfdx force:package:version:list --released
@@ -10,7 +10,8 @@ Promotes a package version to released status.
10
10
 
11
11
  Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.
12
12
 
13
- Examples:
13
+ # examples
14
+
14
15
  $ sfdx force:package:version:promote -p 04t...
15
16
  $ sfdx force:package:version:promote -p awesome_package_alias
16
17
  $ sfdx force:package:version:promote -p "Awesome Package Alias"
@@ -23,7 +24,7 @@ ID (starts with 04t) or alias of the package version to promote
23
24
 
24
25
  The ID (starts with 04t) or alias of the package version to promote.
25
26
 
26
- # packageVersionPromoteSetAsReleasedYesNo
27
+ # packageVersionPromoteConfirm
27
28
 
28
29
  Are you sure you want to release package version %s? You can't undo this action. Release package (y/n)?
29
30
 
@@ -6,9 +6,8 @@ retrieve details about a package version in the Dev Hub org
6
6
 
7
7
  Retrieves details about a package version in the Dev Hub org.
8
8
 
9
- # help
9
+ # examples
10
10
 
11
- Examples:
12
11
  $ sfdx force:package:version:report -p 04t...
13
12
  $ sfdx force:package:version:report -p "Your Package Alias"
14
13
 
@@ -10,7 +10,8 @@ Updates a second-generation package version in the Dev Hub org.
10
10
 
11
11
  Specify a new value for each option you want to update.
12
12
 
13
- Examples:
13
+ # examples
14
+
14
15
  $ sfdx force:package:version:update -p "Your Package Alias" -k password123
15
16
  $ sfdx force:package:version:update -p 04t... -b main -t 'Release 1.0.7'
16
17
  $ sfdx force:package:version:update -p 04t... -e "New Package Version Description"