STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

start codespace to fetch config if it's explicitly requested

Browse source 
When running `gh cs ssh config` without a `-c` option, we skip
codespaces that aren't available. This change suppresses that behavior
when a single codespace is explicitly requested, starting the codespace
if it's not running.
This commit is contained in:
Jason Lunz 2021-12-17 16:57:29 -07:00
parent 61823997c2
commit b2598d64f9
No known key found for this signature in database
GPG key ID: 88F9FD38589448E9
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

11
pkg/cmd/codespace/ssh.go
View file

@ -194,7 +194,7 @@ func (a *App) printOpenSSHConfig(ctx context.Context, opts configOptions) error
fetches := 0
var status error
for _, cs := range codespaces {
if cs.State != "Available" {
if cs.State != "Available" && opts.codespace == "" {
fmt.Fprintf(os.Stderr, "skipping unavailable codespace %s: %s\n", cs.Name, cs.State)
status = cmdutil.SilentError
continue
@ -423,7 +423,7 @@ func newConfigCmd(app *App) *cobra.Command {
configCmd := &cobra.Command{
Use: "config [-c codespace]",
Short: "Write OpenSSH configuration to stdout",
Long: heredoc.Docf(`
Long: heredoc.Doc(`
The config command generates per-codespace ssh configuration in OpenSSH format.
Including this configuration in ~/.ssh/config improves the user experience of other
@ -433,9 +433,10 @@ func newConfigCmd(app *App) *cobra.Command {
If -c/--codespace is specified, configuration is generated for that codespace
only. Otherwise configuration is emitted for all available codespaces.
Codespaces that aren't in "Available" state are skipped because it's necessary to
connect to the running codespace to determine the required remote ssh username.
`, "`"),
When generating configuration for all codespaces, ones that aren't in "Available"
state are skipped because it's necessary to start the codespace to determine its
remote ssh username. When generating configuration for a single codespace with '-c',
`),
Example: heredoc.Doc(`
$ gh codespace config > ~/.ssh/codespaces
$ echo 'include ~/.ssh/codespaces' >> ~/.ssh/config'