From a100c349fd92bfac3092c81e62d58138bc0ddac8 Mon Sep 17 00:00:00 2001 From: mshanemc Date: Tue, 25 Jun 2024 08:36:52 -0500 Subject: [PATCH 1/4] feat: deprecation date notice --- messages/cancel.md | 2 +- messages/deploy.md | 2 +- messages/md.cancel.md | 2 +- messages/md.deploy.md | 2 +- messages/md.deployreport.md | 2 +- messages/md.retrieve.md | 2 +- messages/pull.md | 2 +- messages/push.md | 2 +- messages/report.md | 2 +- messages/retrieve.md | 2 +- messages/status.md | 2 +- src/commands/force.ts | 5 +++++ src/commands/force/mdapi/retrieve/report.ts | 4 ++++ 13 files changed, 20 insertions(+), 11 deletions(-) diff --git a/messages/cancel.md b/messages/cancel.md index 276c0348e..5fb58c921 100644 --- a/messages/cancel.md +++ b/messages/cancel.md @@ -36,4 +36,4 @@ The cancel command failed due to: %s # deprecation -We plan to deprecate this command in the future. Try using the "%s" command instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/deploy.md b/messages/deploy.md index 22bab4bbc..7c17b34f1 100644 --- a/messages/deploy.md +++ b/messages/deploy.md @@ -273,4 +273,4 @@ You requested an async deploy with code coverage or JUnit results. The reports w # deprecation -We plan to deprecate this command in the future. Try using the "%s" command instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/md.cancel.md b/messages/md.cancel.md index b47479fd9..72ef51981 100644 --- a/messages/md.cancel.md +++ b/messages/md.cancel.md @@ -36,4 +36,4 @@ The cancel command failed due to: %s. # deprecation -We plan to deprecate this command in the future. Try using the "%s" command instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/md.deploy.md b/messages/md.deploy.md index 9881dce9f..55108b1fb 100644 --- a/messages/md.deploy.md +++ b/messages/md.deploy.md @@ -197,4 +197,4 @@ You requested an async deploy with code coverage or JUnit results. The reports w # deprecation -We plan to deprecate this command in the future. Try using the "%s" command instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/md.deployreport.md b/messages/md.deployreport.md index d9960e875..4cafd8a76 100644 --- a/messages/md.deployreport.md +++ b/messages/md.deployreport.md @@ -54,4 +54,4 @@ Using specified username %s. # deprecation -We plan to deprecate this command in the future. Try using the "%s" and "%s" pair instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" and "%s" pair instead. diff --git a/messages/md.retrieve.md b/messages/md.retrieve.md index 05dd79bec..59bc3b57f 100644 --- a/messages/md.retrieve.md +++ b/messages/md.retrieve.md @@ -117,4 +117,4 @@ If the retrieve request has completed, the retrieved metadata zip file will be w # deprecation -We plan to deprecate this command in the future. Try using the "%s" command instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/pull.md b/messages/pull.md index 5329fba24..1f776a0c8 100644 --- a/messages/pull.md +++ b/messages/pull.md @@ -62,4 +62,4 @@ Your retrieve request did not complete within the specified wait time [%s minute # deprecation -We plan to deprecate this command in the future. Try using the "%s" command instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/push.md b/messages/push.md index df1ab315d..6dccf9de0 100644 --- a/messages/push.md +++ b/messages/push.md @@ -50,4 +50,4 @@ Check the order of your dependencies and ensure all metadata is included. # deprecation -We plan to deprecate this command in the future. Try using the "%s" command instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/report.md b/messages/report.md index 5c99eee71..7dd6b3764 100644 --- a/messages/report.md +++ b/messages/report.md @@ -50,4 +50,4 @@ The metadata deploy operation failed. # deprecation -We plan to deprecate this command in the future. Try using the "%s" and "%s" pair instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" and "%s" pair instead. diff --git a/messages/retrieve.md b/messages/retrieve.md index f429be8eb..9fcbe0667 100644 --- a/messages/retrieve.md +++ b/messages/retrieve.md @@ -193,4 +193,4 @@ The retrieve target directory [%s] overlaps one of your package directories. Spe # deprecation -We plan to deprecate this command in the future. Try using the "%s" command instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/status.md b/messages/status.md index 3c32c6c31..ff274e47f 100644 --- a/messages/status.md +++ b/messages/status.md @@ -34,4 +34,4 @@ No local or remote changes found. # deprecation -We plan to deprecate this command in the future. Try using the "%s" command instead. +This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. diff --git a/src/commands/force.ts b/src/commands/force.ts index 25665ea4b..5e08c856e 100644 --- a/src/commands/force.ts +++ b/src/commands/force.ts @@ -74,6 +74,11 @@ export type ForceCommandResult = { apiVersion: string }; export class ForceCommand extends SfCommand { public static readonly hidden = true; public static readonly examples = []; + public static state = 'deprecated'; + public static readonly deprecationOptions = { + message: + 'The Salesforce CLI does ship an API version. You can use "org display" to see the API version of any org.', + }; // eslint-disable-next-line sf-plugin/no-hardcoded-messages-commands public static readonly summary = 'Display the ASCII art logo for the Salesforce CLI'; diff --git a/src/commands/force/mdapi/retrieve/report.ts b/src/commands/force/mdapi/retrieve/report.ts index adb41c19b..50975c4fa 100644 --- a/src/commands/force/mdapi/retrieve/report.ts +++ b/src/commands/force/mdapi/retrieve/report.ts @@ -33,6 +33,10 @@ export class Report extends SourceCommand { public static readonly description = messages.getMessage('report.description'); public static readonly examples = messages.getMessages('report.examples'); public static readonly state = 'deprecated'; + public static readonly deprecationOptions = { + to: 'project retrieve report', + message: messages.getMessage('deprecation', ['project retrieve report']), + }; public static readonly hidden = true; public static readonly flags = { 'api-version': orgApiVersionFlagWithDeprecations, From ede147dff9aaf4eb900efa165c5f6d4520ba413b Mon Sep 17 00:00:00 2001 From: mshanemc Date: Tue, 25 Jun 2024 08:40:10 -0500 Subject: [PATCH 2/4] docs: message update --- src/commands/force.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/commands/force.ts b/src/commands/force.ts index 5e08c856e..fa0897470 100644 --- a/src/commands/force.ts +++ b/src/commands/force.ts @@ -76,8 +76,7 @@ export class ForceCommand extends SfCommand { public static readonly examples = []; public static state = 'deprecated'; public static readonly deprecationOptions = { - message: - 'The Salesforce CLI does ship an API version. You can use "org display" to see the API version of any org.', + message: 'Use "org display" to see the API version of any org.', }; // eslint-disable-next-line sf-plugin/no-hardcoded-messages-commands public static readonly summary = 'Display the ASCII art logo for the Salesforce CLI'; From 975384b1e8ec88e49561c1df44dc3f7ace76575c Mon Sep 17 00:00:00 2001 From: svc-cli-bot Date: Tue, 25 Jun 2024 16:33:57 +0000 Subject: [PATCH 3/4] chore(release): 3.4.9-demo.0 [skip ci] --- README.md | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 793131574..6eb1b022d 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ $ npm install -g @salesforce/plugin-source $ sfdx COMMAND running command... $ sfdx (--version) -@salesforce/plugin-source/3.4.8 linux-x64 node-v18.20.3 +@salesforce/plugin-source/3.4.9-demo.0 linux-x64 node-v18.20.3 $ sfdx --help [COMMAND] USAGE $ sfdx COMMAND diff --git a/package.json b/package.json index b1ee6ba8e..030c111c9 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/plugin-source", "description": "Commands to interact with source formatted metadata", - "version": "3.4.8", + "version": "3.4.9-demo.0", "author": "Salesforce", "bugs": "https://github.com/forcedotcom/cli/issues", "dependencies": { From b5559e57e5bfaa9f07c9abc3fb3e5e376c3a8a41 Mon Sep 17 00:00:00 2001 From: Shane McLaughlin Date: Wed, 26 Jun 2024 07:55:26 -0500 Subject: [PATCH 4/4] docs: suggestions from code review Co-authored-by: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> --- messages/cancel.md | 2 +- messages/deploy.md | 2 +- messages/md.cancel.md | 2 +- messages/md.deploy.md | 2 +- messages/md.deployreport.md | 2 +- messages/md.retrieve.md | 2 +- messages/pull.md | 2 +- messages/push.md | 2 +- messages/report.md | 2 +- messages/retrieve.md | 2 +- messages/status.md | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/messages/cancel.md b/messages/cancel.md index 5fb58c921..249c0c8c4 100644 --- a/messages/cancel.md +++ b/messages/cancel.md @@ -36,4 +36,4 @@ The cancel command failed due to: %s # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/deploy.md b/messages/deploy.md index 7c17b34f1..065990828 100644 --- a/messages/deploy.md +++ b/messages/deploy.md @@ -273,4 +273,4 @@ You requested an async deploy with code coverage or JUnit results. The reports w # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/md.cancel.md b/messages/md.cancel.md index 72ef51981..daeed57a1 100644 --- a/messages/md.cancel.md +++ b/messages/md.cancel.md @@ -36,4 +36,4 @@ The cancel command failed due to: %s. # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/md.deploy.md b/messages/md.deploy.md index 55108b1fb..6a8f802f9 100644 --- a/messages/md.deploy.md +++ b/messages/md.deploy.md @@ -197,4 +197,4 @@ You requested an async deploy with code coverage or JUnit results. The reports w # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/md.deployreport.md b/messages/md.deployreport.md index 4cafd8a76..12b62ebfa 100644 --- a/messages/md.deployreport.md +++ b/messages/md.deployreport.md @@ -54,4 +54,4 @@ Using specified username %s. # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" and "%s" pair instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" and "%s" pair instead. diff --git a/messages/md.retrieve.md b/messages/md.retrieve.md index 59bc3b57f..5aa708309 100644 --- a/messages/md.retrieve.md +++ b/messages/md.retrieve.md @@ -117,4 +117,4 @@ If the retrieve request has completed, the retrieved metadata zip file will be w # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/pull.md b/messages/pull.md index 1f776a0c8..5f5f24ced 100644 --- a/messages/pull.md +++ b/messages/pull.md @@ -62,4 +62,4 @@ Your retrieve request did not complete within the specified wait time [%s minute # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/push.md b/messages/push.md index 6dccf9de0..616c5fe05 100644 --- a/messages/push.md +++ b/messages/push.md @@ -50,4 +50,4 @@ Check the order of your dependencies and ensure all metadata is included. # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/report.md b/messages/report.md index 7dd6b3764..8b7df3ab6 100644 --- a/messages/report.md +++ b/messages/report.md @@ -50,4 +50,4 @@ The metadata deploy operation failed. # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" and "%s" pair instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" and "%s" pair instead. diff --git a/messages/retrieve.md b/messages/retrieve.md index 9fcbe0667..ddfbc6d74 100644 --- a/messages/retrieve.md +++ b/messages/retrieve.md @@ -193,4 +193,4 @@ The retrieve target directory [%s] overlaps one of your package directories. Spe # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" command instead. diff --git a/messages/status.md b/messages/status.md index ff274e47f..6dba1c193 100644 --- a/messages/status.md +++ b/messages/status.md @@ -34,4 +34,4 @@ No local or remote changes found. # deprecation -This command is deprecated and will be removed from the CLI on November 6, 2024. Use the "%s" command instead. +This command is deprecated and will be removed from Salesforce CLI on November 6, 2024. Use the "%s" command instead.