Add CS_BETA and note --coder-bind is in beta
This commit is contained in:
parent
9ff37977a8
commit
a5b6d080bd
|
@ -67,9 +67,9 @@ interface Option<T> {
|
||||||
description?: string
|
description?: string
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Whether to print this option in --help output
|
* If marked as beta, the option is not printed unless $CS_BETA is set.
|
||||||
*/
|
*/
|
||||||
hidden?: boolean
|
beta?: boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
type OptionType<T> = T extends boolean
|
type OptionType<T> = T extends boolean
|
||||||
|
@ -170,8 +170,10 @@ const options: Options<Required<Args>> = {
|
||||||
Securely bind code-server via Coder Cloud with the passed name. You'll get a URL like
|
Securely bind code-server via Coder Cloud with the passed name. You'll get a URL like
|
||||||
https://myname.coder-cloud.com at which you can easily access your code-server instance.
|
https://myname.coder-cloud.com at which you can easily access your code-server instance.
|
||||||
Authorization is done via GitHub.
|
Authorization is done via GitHub.
|
||||||
|
This is presently beta and requires being accepted for testing.
|
||||||
|
See https://github.com/cdr/code-server/discussions/2137
|
||||||
`,
|
`,
|
||||||
hidden: true,
|
beta: true,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -184,8 +186,16 @@ export const optionDescriptions = (): string[] => {
|
||||||
}),
|
}),
|
||||||
{ short: 0, long: 0 },
|
{ short: 0, long: 0 },
|
||||||
)
|
)
|
||||||
return entries.filter(([_, v]) => !v.hidden).map(([k, v]) => {
|
return entries
|
||||||
const help = `${" ".repeat(widths.short - (v.short ? v.short.length : 0))}${v.short ? `-${v.short}` : " "} --${k} `
|
.filter(([, v]) => {
|
||||||
|
// If CS_BETA is set, we show beta options but if not, then we do not want
|
||||||
|
// to show beta options.
|
||||||
|
return process.env.CS_BETA || !v.beta
|
||||||
|
})
|
||||||
|
.map(([k, v]) => {
|
||||||
|
const help = `${" ".repeat(widths.short - (v.short ? v.short.length : 0))}${
|
||||||
|
v.short ? `-${v.short}` : " "
|
||||||
|
} --${k} `
|
||||||
return (
|
return (
|
||||||
help +
|
help +
|
||||||
v.description
|
v.description
|
||||||
|
|
|
@ -33,6 +33,8 @@ function runAgent(...args: string[]): Promise<void> {
|
||||||
}
|
}
|
||||||
|
|
||||||
export function coderCloudBind(csAddr: string, serverName = ""): Promise<void> {
|
export function coderCloudBind(csAddr: string, serverName = ""): Promise<void> {
|
||||||
|
logger.info("Remember --coder-bind is a beta feature and requires being accepted for testing")
|
||||||
|
logger.info("See https://github.com/cdr/code-server/discussions/2137")
|
||||||
// addr needs to be in host:port format.
|
// addr needs to be in host:port format.
|
||||||
// So we trim the protocol.
|
// So we trim the protocol.
|
||||||
csAddr = csAddr.replace(/^https?:\/\//, "")
|
csAddr = csAddr.replace(/^https?:\/\//, "")
|
||||||
|
|
Loading…
Reference in New Issue