Skip to content

Commit 316caec

Browse files
authored
Merge pull request #966 from salesforcecli/btrn/fix-help-texts-plugin
@W-18683180 Fix help texts messages and remove beta flags
2 parents 72ae65b + 7da85f0 commit 316caec

9 files changed

Lines changed: 472 additions & 886 deletions

File tree

command-snapshot.json

Lines changed: 449 additions & 866 deletions
Large diffs are not rendered by default.

messages/package_pushupgrade_abort.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Abort a package push upgrade that has been scheduled. Only push upgrade requests
44

55
# description
66

7-
Specify the request ID for which you want abort the request. If applicable, the command displays errors related to the request. Only package push requests in Created or Pending statuses can be aborted.
7+
Specify the request ID for which you want abort the request. If applicable, the command displays errors related to the request.
88

99
To show all requests in the org, run "<%= config.bin %> package pushupgrade list --package 033...".
1010

messages/package_pushupgrade_list.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@ Status used to filter the list output Valid values are: Created, Canceled, Pendi
2626

2727
Display only push upgrade requests for package migrations.
2828

29-
# flags.verbose.summary
30-
31-
Displays additional information such as number of orgs scheduled for push upgrade, orgs successfully upgraded, etc.
32-
3329
# examples
3430

3531
- List all package push upgrade requests in the specified Dev Hub org:
@@ -40,13 +36,13 @@ Displays additional information such as number of orgs scheduled for push upgrad
4036

4137
<%= config.bin %> <%= command.id %> --package 033xyz --scheduled-last-days 30 --target-dev-hub myHub
4238

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

45-
<%= config.bin %> <%= command.id %> --package 033xyz –-Status=Success
41+
<%= config.bin %> <%= command.id %> --package 033xyz –-status Succeeded
4642

47-
- List all package push upgrade with a status Error:
43+
- List all package push upgrade with a status Failed:
4844

49-
<%= config.bin %> <%= command.id %> --package 033xyz –-Status=Error
45+
<%= config.bin %> <%= command.id %> --package 033xyz –-status Failed
5046

5147
# id
5248

messages/package_pushupgrade_report.md

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

1111
# examples
1212

13-
- Retrieve details about the package push updgrade with the specified ID; uses your default Dev Hub org:
13+
- Retrieve details about the package push upgrade with the specified ID; uses your default Dev Hub org:
1414

1515
<%= config.bin %> <%= command.id %> --push-request-id 0DV...
1616

messages/package_pushupgrade_schedule.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To initiate a push upgrade for an unlocked or second-generation managed package,
99
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-
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.
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

@@ -27,10 +27,22 @@ ID (starts with 04t) of the package version that the package is being upgraded t
2727

2828
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

30+
# flags.start-time.description
31+
32+
Scheduled push upgrades begin as soon as resources are available on the Salesforce instance, which is either at or after the start time you specify. In certain scenarios, the push upgrade starts a few hours after the scheduled start time.
33+
34+
As a best practice, schedule push upgrades at off-peak hours like 1:00 AM Saturday.
35+
If you don't specify this flag, the push upgrade is scheduled to run as soon as resources are available on the Salesforce instance.
36+
3037
# flags.org-file.summary
3138

3239
Filename of the CSV file that contains the list of orgs that need the package upgrade.
3340

41+
# flags.org-file.description
42+
43+
The file must contain one org per line. The org ID must be the only value in each row.
44+
All listed orgs must have a package version installed in their org that is lower than the package version you specified for the --package-version flag.
45+
3446
# flags.org-list.summary
3547

3648
Comma-separated list of subscriber org IDs that need the package upgrade.
@@ -94,3 +106,4 @@ Package Version Id
94106
# output
95107

96108
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".
109+
Orgs scheduled for push upgrade: {%s}

src/commands/package/push-upgrade/abort.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ export class PackagePushUpgradeAbortCommand extends SfCommand<boolean> {
1515
public static readonly summary = messages.getMessage('summary');
1616
public static readonly description = messages.getMessage('description');
1717
public static readonly examples = messages.getMessages('examples');
18-
public static readonly hidden = true;
19-
public static state = 'beta';
2018
public static readonly flags = {
2119
'target-dev-hub': Flags.requiredHub(),
2220
'api-version': Flags.orgApiVersion(),

src/commands/package/push-upgrade/list.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ export class PackagePushRequestListCommand extends SfCommand<PackagePushRequestL
2020
public static readonly summary = messages.getMessage('summary');
2121
public static readonly description = messages.getMessage('description');
2222
public static readonly examples = messages.getMessages('examples');
23-
public static readonly hidden = true;
24-
public static state = 'beta';
2523
public static readonly aliases = ['force:package:push-upgrade:list'];
2624
public static readonly flags = {
2725
'target-dev-hub': requiredHubFlag,

src/commands/package/push-upgrade/report.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,6 @@ export class PackagePushUpgradeReportCommand extends SfCommand<ReportCommandResu
2929
public static readonly examples = messages.getMessages('examples');
3030
public static readonly deprecateAliases = true;
3131
public static readonly aliases = ['force:package:push-upgrade:report'];
32-
public static readonly hidden = true;
33-
public static readonly state = 'beta';
3432
public static readonly flags = {
3533
loglevel,
3634
'target-dev-hub': requiredHubFlag,

src/commands/package/push-upgrade/schedule.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ export class PackagePushScheduleCommand extends SfCommand<PackagePushScheduleRes
1616
public static readonly summary = messages.getMessage('summary');
1717
public static readonly description = messages.getMessage('description');
1818
public static readonly examples = messages.getMessages('examples');
19-
public static readonly hidden = true;
20-
public static state = 'beta';
2119
public static readonly flags = {
2220
'target-dev-hub': Flags.requiredHub({
2321
char: 'v',
@@ -36,6 +34,7 @@ export class PackagePushScheduleCommand extends SfCommand<PackagePushScheduleRes
3634
'start-time': Flags.string({
3735
char: 't',
3836
summary: messages.getMessage('flags.start-time.summary'),
37+
description: messages.getMessage('flags.start-time.description'),
3938
}),
4039
'org-list': Flags.string({
4140
char: 'l',
@@ -45,6 +44,7 @@ export class PackagePushScheduleCommand extends SfCommand<PackagePushScheduleRes
4544
'org-file': Flags.file({
4645
char: 'f',
4746
summary: messages.getMessage('flags.org-file.summary'),
47+
description: messages.getMessage('flags.org-file.description'),
4848
exists: true,
4949
exclusive: ['org-list'],
5050
}),
@@ -83,7 +83,7 @@ export class PackagePushScheduleCommand extends SfCommand<PackagePushScheduleRes
8383
);
8484

8585
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
86-
this.log(messages.getMessage('output', [result?.PushRequestId]));
86+
this.log(messages.getMessage('output', [result?.PushRequestId, orgList.join(', ')]));
8787

8888
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
8989
return result;

0 commit comments

Comments
 (0)