Movatterモバイル変換

Skip to content

coder/coderPublic

NotificationsYou must be signed in to change notification settings
Fork909
Star10k

Commit98e7860

matifali

committed

Update SSH usage examples and documentation

Revise various parts of the CLI and documentation to reflect the new SSH connection format for workspaces. Update usage examples from the outdated "ssh coder.workspace" format to the new "ssh workspace.coder" format. Additionally, ensure correct formation in commands by adding workspace owner username and hostname suffix through recent data sources.

1 parenta19539c commit98e7860Copy full SHA for 98e7860

File tree

9 files changed

+12

-10

lines changed

cli
- configssh.go
- testdata
  - coder_--help.golden
  - coder_config-ssh_--help.golden
docs
- manifest.json
- reference/cli
  - config-ssh.md
  - index.md
- tutorials
  - testing-templates.md
site/src/modules/resources
- AgentRow.tsx
- SSHButton
  - SSHButton.tsx

9 files changed

+12

-10

lines changed

`‎cli/configssh.go`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -235,7 +235,7 @@ func (r RootCmd) configSSH() serpent.Command {`
`235`	`235`	`cmd:=&serpent.Command{`
`236`	`236`	`Annotations:workspaceCommand,`
`237`	`237`	`Use:"config-ssh",`
`238`		`-Short:"Add an SSH Host entry for your workspaces\"sshcoder.workspace\"",`
	`238`	`+Short:"Add an SSH Host entry for your workspaces\"ssh workspace.coder\"",`
`239`	`239`	`Long:FormatExamples(`
`240`	`240`	`Example{`
`241`	`241`	`Description:"You can use -o (or --ssh-option) so set SSH options to be used for all your workspaces",`

`‎cli/testdata/coder_--help.golden`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ SUBCOMMANDS:`
`18`	`18`	`completion Install or update shell completion scripts for the`
`19`	`19`	`detected or chosen shell.`
`20`	`20`	`config-ssh Add an SSH Host entry for your workspaces "ssh`
`21`		`-coder.workspace"`
	`21`	`+ workspace.coder"`
`22`	`22`	`create Create a workspace`
`23`	`23`	`delete Delete a workspace`
`24`	`24`	`dotfiles Personalize your workspace by applying a canonical`

`‎cli/testdata/coder_config-ssh_--help.golden`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ coder v0.0.0-devel`
`3`	`3`	`USAGE:`
`4`	`4`	`coder config-ssh [flags]`
`5`	`5`
`6`		`- Add an SSH Host entry for your workspaces "sshcoder.workspace"`
	`6`	`+ Add an SSH Host entry for your workspaces "ssh workspace.coder"`
`7`	`7`
`8`	`8`	`- You can use -o (or --ssh-option) so set SSH options to be used for all`
`9`	`9`	`your`

`‎docs/manifest.json`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -1091,7 +1091,7 @@`
`1091`	`1091`	`},`
`1092`	`1092`	`{`
`1093`	`1093`	`"title":"config-ssh",`
`1094`		`-"description":"Add an SSH Host entry for your workspaces\"sshcoder.workspace\"",`
	`1094`	`+"description":"Add an SSH Host entry for your workspaces\"ssh workspace.coder\"",`
`1095`	`1095`	`"path":"reference/cli/config-ssh.md"`
`1096`	`1096`	`},`
`1097`	`1097`	`{`

`‎docs/reference/cli/config-ssh.md`

Lines changed: 1 addition & 1 deletion

Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

`‎docs/reference/cli/index.md`

Lines changed: 1 addition & 1 deletion

Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

`‎docs/tutorials/testing-templates.md`

Lines changed: 1 addition & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -103,9 +103,8 @@ jobs:`
`103`	`103`	`-name:Create a test workspace and run some example commands`
`104`	`104`	`run:\|`
`105`	`105`	`coder create -t $TEMPLATE_NAME --template-version ${{ steps.name.outputs.version_name }} test-${{ steps.name.outputs.version_name }} --yes`
`106`		`- coder config-ssh --yes`
`107`	`106`	`# run some example commands`
`108`		`- sshcoder.test-${{ steps.name.outputs.version_name }} -- make build`
	`107`	`+coderssh test-${{ steps.name.outputs.version_name }} -- make build`
`109`	`108`
`110`	`109`	`-name:Delete the test workspace`
`111`	`110`	`if:always()`

`‎site/src/modules/resources/AgentRow.tsx`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -196,6 +196,7 @@ export const AgentRow: FC<AgentRowProps> = ({`
`196`	`196`	`<AgentSSHButton`
`197`	`197`	`workspaceName={workspace.name}`
`198`	`198`	`agentName={agent.name}`
	`199`	`+workspaceOwnerUsername={workspace.owner_name}`
`199`	`200`	`/>`
`200`	`201`	`)}`
`201`	`202`	`{proxy.preferredWildcardHostname!==""&&`

`‎site/src/modules/resources/SSHButton/SSHButton.tsx`

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -22,15 +22,17 @@ import { docs } from "utils/docs";`
`22`	`22`	`interfaceAgentSSHButtonProps{`
`23`	`23`	`workspaceName:string;`
`24`	`24`	`agentName:string;`
	`25`	`+workspaceOwnerUsername:string;`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`exportconstAgentSSHButton:FC<AgentSSHButtonProps>=({`
`28`	`29`	`workspaceName,`
`29`	`30`	`agentName,`
	`31`	`+workspaceOwnerUsername,`
`30`	`32`	`})=>{`
`31`	`33`	`constpaper=useClassName(classNames.paper,[]);`
`32`	`34`	`const{ data}=useQuery(deploymentSSHConfig());`
`33`		`-constsshPrefix=data?.hostname_prefix;`
	`35`	`+constsshSuffix=data?.hostname_suffix;`
`34`	`36`
`35`	`37`	`return(`
`36`	`38`	`<Popover>`
`@@ -58,7 +60,7 @@ export const AgentSSHButton: FC<AgentSSHButtonProps> = ({`
`58`	`60`	`/>`
`59`	`61`	`<SSHStep`
`60`	`62`	`helpText="Connect to the agent:"`
`61`		-codeExample={`ssh${sshPrefix}${workspaceName}.${agentName}`}
	`63`	+codeExample={`ssh${workspaceName}.${agentName}.${workspaceOwnerUsername}.${sshSuffix}`}
`62`	`64`	`/>`
`63`	`65`	`</Stack>`
`64`	`66`	`</ol>`

0 commit comments

Comments

(0)

[8]ページ先頭

©2009-2025 Movatter.jp