Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: deprecate ssh commands #5069

Merged
merged 3 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/@ionic/cli/src/commands/ssh/add.ts
Original file line number Diff line number Diff line change
@@ -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';
Expand Down Expand Up @@ -33,6 +33,7 @@ export class SSHAddCommand extends SSHBaseCommand implements CommandPreRun {
type: Boolean,
},
],
groups: [MetadataGroup.DEPRECATED],
};
}

Expand Down
3 changes: 2 additions & 1 deletion packages/@ionic/cli/src/commands/ssh/delete.ts
Original file line number Diff line number Diff line change
@@ -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';
Expand All @@ -18,6 +18,7 @@ export class SSHDeleteCommand extends SSHBaseCommand implements CommandPreRun {
validators: [validators.required],
},
],
groups: [MetadataGroup.DEPRECATED],
};
}

Expand Down
1 change: 1 addition & 0 deletions packages/@ionic/cli/src/commands/ssh/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export class SSHGenerateCommand extends SSHBaseCommand implements CommandPreRun
groups: [MetadataGroup.ADVANCED],
},
],
groups: [MetadataGroup.DEPRECATED],
};
}

Expand Down
4 changes: 4 additions & 0 deletions packages/@ionic/cli/src/commands/ssh/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { MetadataGroup } from '@ionic/cli-framework';
import { input } from '../../lib/color';
import { CommandMap, Namespace } from '../../lib/namespace';

Expand All @@ -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],
};
}

Expand Down
2 changes: 2 additions & 0 deletions packages/@ionic/cli/src/commands/ssh/list.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { MetadataGroup } from '@ionic/cli-framework';
import { columnar } from '@ionic/utils-terminal';

import { COLUMNAR_OPTIONS } from '../../constants';
Expand All @@ -19,6 +20,7 @@ export class SSHListCommand extends SSHBaseCommand implements CommandPreRun {
type: Boolean,
},
],
groups: [MetadataGroup.DEPRECATED],
};
}

Expand Down
2 changes: 2 additions & 0 deletions packages/@ionic/cli/src/commands/ssh/setup.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { MetadataGroup } from '@ionic/cli-framework';
import { pathExists } from '@ionic/utils-fs';
import { prettyPath } from '@ionic/utils-terminal';

Expand Down Expand Up @@ -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],
};
}

Expand Down
3 changes: 2 additions & 1 deletion packages/@ionic/cli/src/commands/ssh/use.ts
Original file line number Diff line number Diff line change
@@ -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';

Expand Down Expand Up @@ -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],
};
}

Expand Down