Skip to content

Commit 8e3aae2

Browse files
committed
fix: help text for schedule command
1 parent 03ceace commit 8e3aae2

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

messages/package_pushupgrade_schedule.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# summary
22

3-
Schedules a package push upgrade request.
3+
Schedule a package push upgrade.
44

55
# description
66

77
Represents a push upgrade request for upgrading a package in one or many orgs from one version to another version.
88
To initiate a push upgrade for an unlocked or second-generation managed package, the Create and Update Second-Generation Packages user permission is required.
9-
The push upgrade feature is only available second-generation managed packages that have passed AppExchange security review. To enable push upgrades for your managed package, log a support case in the Salesforce Partner Community.
9+
For second-generation managed packages, the push upgrade feature is available only for packages that have passed AppExchange security review. To enable push upgrades for your managed package, log a support case in the Salesforce Partner Community.
1010
For unlocked packages, push upgrades are enabled by default.
1111

12-
When the –migrate-to-2GP flag is used, this command lets you push a package migration for a first-generation managed package that has been converted to second-generation managed package. This push migration is used to update orgs that have the first-generation managed package installed.
12+
Use the –migrate-to-2GP flag to indicate you’re installing a converted second-generation managed package into an org that has the first-generation managed package version of that package installed.
1313

1414
# flags.target-dev-hub.summary
1515

@@ -21,19 +21,19 @@ Overrides the value of the target-dev-hub configuration variable, if set.
2121

2222
# flags.package.summary
2323

24-
ID (starts with 04t) of the package version that the package is be upgraded to. The package version must be an active, non-beta package version.
24+
ID (starts with 04t) of the package version that the package is being upgraded to. The package version must be an active, non-beta package version.
2525

2626
# flags.start-time.summary
2727

28-
Specify the date and time (UTC) when the push upgrade is processed. Set this value to the earliest time that you want Salesforce to attempt to start the upgrade.
28+
Date and time (UTC) when the push upgrade is processed. Set to the earliest time that you want Salesforce to attempt to start the upgrade.
2929

3030
# flags.org-file.summary
3131

3232
The filename of the .csv file that contains the list of orgs that need the package upgrade.
3333

3434
# flags.org-list.summary
3535

36-
Supply subscriber organization ids that can be pushed upgrade.
36+
List of subscriber org IDs that can be push upgraded.
3737

3838
# error.invalid-package-version
3939

@@ -49,19 +49,19 @@ Org list file is invalid.
4949

5050
# error.invalid-org-list
5151

52-
Org list has invalid org/orgs.
52+
Org list has invalid org IDs.
5353

5454
# error.no-org-list-file-or-org-list-input
5555

5656
Either org list file or org list input must be supplied.
5757

5858
# examples
5959

60-
sf package pushupgrade schedule --package-version 04txyz --scheduled-start-time "2024-12-06T21:00:00" --org-list upgrade-orgs.csv --target-dev-hub myHub
60+
Schedule a push upgrade that initiates at a specified time:
61+
<%= config.bin %> <%= command.id %> --package 04txyz --start-time "2024-12-06T21:00:00" --org-file upgrade-orgs.csv
6162

62-
sf package pushupgrade schedule --package-version 04txyz --org-list upgrade-orgs.csv --target-dev-hub myHub
63-
64-
sf package pushupgrade schedule --migrate-to-2gp --package-version 04txyz --scheduled-start-time "2024-12-06T21:00:00" --org-list upgrade-orgs.csv --target-dev-hub myHub
63+
Schedule a push upgrade that initiates as soon as possible:
64+
<%= config.bin %> <%= command.id %> --package 04txyz --org-file upgrade-orgs.csv
6565

6666
# id
6767

@@ -81,4 +81,4 @@ Package Version Id
8181

8282
# output
8383

84-
Push upgrade has been scheduled. To check the status of this push upgrade, use push upgrade request ID [%s] with either sf package pushupgrade list or sf package pushupgrade report.
84+
Push upgrade has been scheduled. To check the status of this push upgrade, use push upgrade request ID [%s] with either package push-upgrade list or package push-upgrade report.

0 commit comments

Comments
 (0)