From 548053614ad0064751e4064c7c6cf7dff09f3b93 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Sun, 4 Sep 2022 14:19:15 +0200
Subject: [PATCH] cli: deprecate plugin:diff command

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 .changeset/clever-turtles-work.md  |  5 +++++
 packages/cli/cli-report.md         | 12 ------------
 packages/cli/src/commands/index.ts |  6 ++++--
 3 files changed, 9 insertions(+), 14 deletions(-)
 create mode 100644 .changeset/clever-turtles-work.md

diff --git a/.changeset/clever-turtles-work.md b/.changeset/clever-turtles-work.md
new file mode 100644
index 0000000000..9ddad4d1d2
--- /dev/null
+++ b/.changeset/clever-turtles-work.md
@@ -0,0 +1,5 @@
+---
+'@backstage/cli': patch
+---
+
+Deprecated the `plugin:diff` command. If you wish to keep running similar checks in your project we recommend using bespoke scripts. A useful utility for such scripts is `@manypkg/get-packages`, which helps you enumerate all packages in a monorepo.
diff --git a/packages/cli/cli-report.md b/packages/cli/cli-report.md
index 1c86c8723c..f7843db389 100644
--- a/packages/cli/cli-report.md
+++ b/packages/cli/cli-report.md
@@ -13,7 +13,6 @@ Options:
 
 Commands:
   new [options]
-  plugin:diff [options]
   test
   config:docs [options]
   config:print [options]
@@ -379,17 +378,6 @@ Options:
   --watchman
 ```
 
-### `backstage-cli plugin:diff`
-
-```
-Usage: backstage-cli plugin:diff [options]
-
-Options:
-  --check
-  --yes
-  -h, --help
-```
-
 ### `backstage-cli repo`
 
 ```
diff --git a/packages/cli/src/commands/index.ts b/packages/cli/src/commands/index.ts
index 0af1674b6c..43c59665dc 100644
--- a/packages/cli/src/commands/index.ts
+++ b/packages/cli/src/commands/index.ts
@@ -260,10 +260,12 @@ export function registerCommands(program: Command) {
     );
 
   program
-    .command('plugin:diff')
+    .command('plugin:diff', { hidden: true })
     .option('--check', 'Fail if changes are required')
     .option('--yes', 'Apply all changes')
-    .description('Diff an existing plugin with the creation template')
+    .description(
+      'Diff an existing plugin with the creation template [DEPRECATED]',
+    )
     .action(lazy(() => import('./plugin/diff').then(m => m.default)));
 
   // TODO(Rugvip): Deprecate in favor of package variant