chore: deprecate ssh commands (#5069)

ionic-team · Dec 12, 2023 · ed23150 · ed23150
1 parent d09653d
commit ed23150
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 3 deletions.
diff --git a/packages/@ionic/cli/src/commands/ssh/add.ts b/packages/@ionic/cli/src/commands/ssh/add.ts
@@ -1,4 +1,4 @@
-import { validators } from '@ionic/cli-framework';
+import { validators, MetadataGroup } from '@ionic/cli-framework';
 import { pathAccessible, pathExists } from '@ionic/utils-fs';
 import { expandPath, prettyPath } from '@ionic/utils-terminal';
 import * as fs from 'fs';
@@ -33,6 +33,7 @@ export class SSHAddCommand extends SSHBaseCommand implements CommandPreRun {
           type: Boolean,
         },
       ],
+      groups: [MetadataGroup.DEPRECATED],
     };
   }
 

diff --git a/packages/@ionic/cli/src/commands/ssh/delete.ts b/packages/@ionic/cli/src/commands/ssh/delete.ts
@@ -1,4 +1,4 @@
-import { validators } from '@ionic/cli-framework';
+import { validators, MetadataGroup } from '@ionic/cli-framework';
 
 import { CommandLineInputs, CommandLineOptions, CommandMetadata, CommandPreRun } from '../../definitions';
 import { input, strong } from '../../lib/color';
@@ -18,6 +18,7 @@ export class SSHDeleteCommand extends SSHBaseCommand implements CommandPreRun {
           validators: [validators.required],
         },
       ],
+      groups: [MetadataGroup.DEPRECATED],
     };
   }
 

diff --git a/packages/@ionic/cli/src/commands/ssh/generate.ts b/packages/@ionic/cli/src/commands/ssh/generate.ts
@@ -44,6 +44,7 @@ export class SSHGenerateCommand extends SSHBaseCommand implements CommandPreRun
           groups: [MetadataGroup.ADVANCED],
         },
       ],
+      groups: [MetadataGroup.DEPRECATED],
     };
   }
 

diff --git a/packages/@ionic/cli/src/commands/ssh/index.ts b/packages/@ionic/cli/src/commands/ssh/index.ts
@@ -1,3 +1,4 @@
+import { MetadataGroup } from '@ionic/cli-framework';
 import { input } from '../../lib/color';
 import { CommandMap, Namespace } from '../../lib/namespace';
 
@@ -12,13 +13,16 @@ export class SSHNamespace extends Namespace {
 These commands help automate your SSH configuration for Ionic. As an alternative, SSH configuration can be done entirely manually by visiting your Personal Settings[^dashboard-settings-ssh-keys].
 
 To begin, run ${input('ionic ssh setup')}, which lets you use existing keys or generate new ones just for Ionic.
+
+Deprecated. Developers should configure SSH by visiting their Personal Settings at https://dashboard.ionicframework.com/settings/ssh-keys.
       `,
       footnotes: [
         {
           id: 'dashboard-settings-ssh-keys',
           url: `${dashUrl}/settings/ssh-keys`,
         },
       ],
+      groups: [MetadataGroup.DEPRECATED],
     };
   }
 

diff --git a/packages/@ionic/cli/src/commands/ssh/list.ts b/packages/@ionic/cli/src/commands/ssh/list.ts
@@ -1,3 +1,4 @@
+import { MetadataGroup } from '@ionic/cli-framework';
 import { columnar } from '@ionic/utils-terminal';
 
 import { COLUMNAR_OPTIONS } from '../../constants';
@@ -19,6 +20,7 @@ export class SSHListCommand extends SSHBaseCommand implements CommandPreRun {
           type: Boolean,
         },
       ],
+      groups: [MetadataGroup.DEPRECATED],
     };
   }
 

diff --git a/packages/@ionic/cli/src/commands/ssh/setup.ts b/packages/@ionic/cli/src/commands/ssh/setup.ts
@@ -1,3 +1,4 @@
+import { MetadataGroup } from '@ionic/cli-framework';
 import { pathExists } from '@ionic/utils-fs';
 import { prettyPath } from '@ionic/utils-terminal';
 
@@ -31,6 +32,7 @@ If you are having issues setting up SSH keys, please get in touch with our Suppo
           url: 'https://ion.link/support-request',
         },
       ],
+      groups: [MetadataGroup.DEPRECATED],
     };
   }
 

diff --git a/packages/@ionic/cli/src/commands/ssh/use.ts b/packages/@ionic/cli/src/commands/ssh/use.ts
@@ -1,4 +1,4 @@
-import { validators } from '@ionic/cli-framework';
+import { validators, MetadataGroup } from '@ionic/cli-framework';
 import { fileToString, writeFile } from '@ionic/utils-fs';
 import { expandPath, prettyPath } from '@ionic/utils-terminal';
 
@@ -32,6 +32,7 @@ Before making changes, ${input('ionic ssh use')} will print a diff and ask for p
           validators: [validators.required],
         },
       ],
+      groups: [MetadataGroup.DEPRECATED],
     };
   }