Skip to content

Commit ce58855

Browse files
committed
fix: update help text for all push upgrade commands
1 parent 8e3aae2 commit ce58855

File tree

5 files changed

+25
-21
lines changed

5 files changed

+25
-21
lines changed

messages/package_pushupgrade_abort.md

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

3-
Aborts a package push upgrade that has been scheduled. Only push upgrade requests with a Status of Created or Pending can be aborted.
3+
Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending can be aborted.
44

55
# description
66

@@ -20,7 +20,7 @@ To show all requests in the org, run "<%= config.bin %> package pushupgrade list
2020

2121
# flags.push-request-id.summary
2222

23-
The ID of the package push request (starts with 0DV). This ID is returned after the package pushupgrade schedule command is run.
23+
ID of the package push request (starts with 0DV). This ID is returned after the package push-upgrade schedule command completes successfully.
2424

2525
# flags.target-dev-hub.summary
2626

@@ -32,15 +32,15 @@ Overrides the value of the target-dev-hub configuration variable, if set.
3232

3333
# error.invalid-push-request-id-owner
3434

35-
--push-request-id 0DV... is not owned by the org from where the CLI command is run.
35+
Can’t abort package push upgrade request. The specified push upgrade ID is associated with a package in a different Dev Hub org. Retry this command in the context of the Dev Hub org that owns the package.
3636

3737
# error.invalid-push-request-id
3838

39-
Package push upgrade request id is invalid. Please use valid ID (starts with 0DV).
39+
Can’t abort package push upgrade request. The specified push upgrade ID isn’t valid. Check the ID (starts with 0DV) and retry the command.
4040

4141
# error.invalid-push-request-status
4242

43-
The status of the push request is one of the following: In Progress, Succeeded, Failed, Canceled. Only push requests in Created or Pending statuses can be aborted.
43+
Can’t abort package push upgrade request with status '${pushRequest.Status}'. Only push upgrade requests with a status of 'Created' or 'Pending' can be cancelled.
4444

4545
# status
4646

messages/package_pushupgrade_list.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ All filter parameters are applied using the AND logical operator (not OR).
1010

1111
To get information about a specific request, run "sf package pushupgrade report" and supply the request ID.
1212

13-
# flags.package-id.summary
13+
# flags.package.summary
1414

15-
Specify the package ID (starts with 033) of the package that you want push upgrade information for.
15+
Package ID (starts with 033) of the package that you want push upgrade information for.
1616

1717
# flags.scheduled-last-days.summary
1818

19-
Filter the list output to only display push upgrades scheduled in the last few days. For example, if this flag is set to 30, only push upgrade requests scheduled for the last 30 days are listed in the output.
19+
Number of days in the past for which to display the list of push upgrade requests that were scheduled. Used to filter the list output to only recently scheduled push upgrades.
2020

2121
# flags.status.summary
2222

23-
Filter the list output by one of the following statuses: Created, Canceled, Pending, In Progress, Failed, or Succeeded
23+
Status used to filter the list output Valid values are: Created, Canceled, Pending, In Progress, Failed, or Succeeded
2424

2525
# flags.verbose.summary
2626

@@ -30,15 +30,19 @@ Displays additional information such as number of orgs scheduled for push upgrad
3030

3131
- List all package push upgrade requests in the specified Dev Hub org:
3232

33-
sf package pushupgrade list --package 033xyz --target-dev-hub myHub
33+
<%= config.bin %> <%= command.id %> --package 033xyz --target-dev-hub myHub
3434

3535
- List all package push upgrade requests in the specified Dev Hub org scheduled in the last 30 days:
3636

37-
sf package pushupgrade list --package 033xyz --scheduled-last-days 30 --target-dev-hub myHub
37+
<%= config.bin %> <%= command.id %> --package 033xyz --scheduled-last-days 30 --target-dev-hub myHub
3838

39-
- List all package push upgrade with a status Succeeded:
39+
- List all package push upgrade with a status Success:
4040

41-
sf package pushupgrade list --package 033xyz –-Status=Succeeded
41+
<%= config.bin %> <%= command.id %> --package 033xyz –-Status=Success
42+
43+
- List all package push upgrade with a status Error:
44+
45+
<%= config.bin %> <%= command.id %> --package 033xyz –-Status=Error
4246

4347
# id
4448

messages/package_pushupgrade_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To show all requests in the org, run "<%= config.bin %> package pushupgrade list
2020

2121
# flags.push-request-id.summary
2222

23-
The ID of the package push request (starts with 0DV). This ID is returned after the package pushupgrade schedule command is run.
23+
ID of the package push request (starts with 0DV). This ID is returned after the package push-upgrade schedule command completes successfully.
2424

2525
# truncatedErrors
2626

messages/package_pushupgrade_schedule.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ Either org list file or org list input must be supplied.
5757

5858
# examples
5959

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
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
6262

63-
Schedule a push upgrade that initiates as soon as possible:
64-
<%= config.bin %> <%= command.id %> --package 04txyz --org-file upgrade-orgs.csv
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

src/commands/package/pushupgrade/list.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ export class PackagePushRequestListCommand extends SfCommand<PackagePushRequestL
2828
public static readonly flags = {
2929
'target-dev-hub': requiredHubFlag,
3030
'api-version': orgApiVersionFlagWithDeprecations,
31-
packageid: Flags.string({
31+
package: Flags.string({
3232
char: 'p',
33-
summary: messages.getMessage('flags.package-id.summary'),
33+
summary: messages.getMessage('flags.package.summary'),
3434
required: true,
3535
}),
3636
'scheduled-last-days': Flags.integer({
@@ -63,7 +63,7 @@ export class PackagePushRequestListCommand extends SfCommand<PackagePushRequestL
6363
// Use const since we will add verbose later
6464
// eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment
6565
const results: PackagePushRequestListResult[] = await PackagePushUpgrade.list(connection, {
66-
packageId: flags.packageid,
66+
packageId: flags.package,
6767
status: flags.status,
6868
scheduledLastDays,
6969
});

0 commit comments

Comments
 (0)