Skip to content

Commit 6a2740f

Browse files
bpmctjsjoeio
andauthored
chore: add deprecation notice for --link (#4562)
Co-authored-by: Joe Previte <[email protected]>
1 parent 3d46604 commit 6a2740f

File tree

3 files changed

+7
-9
lines changed

3 files changed

+7
-9
lines changed

docs/README.md

-4
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,6 @@ code-server.
5656
We also have an in-depth [setup and
5757
configuration](https://coder.com/docs/code-server/latest/guide) guide.
5858

59-
## TLS and authentication (beta)
60-
61-
To add TLS and authentication out of the box, use [code-server --link](https://coder.com/docs/code-server/latest/link).
62-
6359
## Questions?
6460

6561
See answers to [frequently asked

docs/link.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# code-server --link
22

3-
Run code-server with the beta flag `--link` and you'll get TLS, authentication, and a dedicated URL
3+
> Note: This feature is no longer recommended due to instability. Stay tuned for a revised version.
4+
5+
Run code-server with the flag `--link` and you'll get TLS, authentication, and a dedicated URL
46
for accessing your IDE out of the box.
57

68
```console

src/node/cli.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ interface Option<T> {
104104
description?: string
105105

106106
/**
107-
* If marked as beta, the option is marked as beta in help.
107+
* If marked as deprecated, the option is marked as deprecated in help.
108108
*/
109-
beta?: boolean
109+
deprecated?: boolean
110110
}
111111

112112
type OptionType<T> = T extends boolean
@@ -230,7 +230,7 @@ const options: Options<Required<UserProvidedArgs>> = {
230230
https://hostname-username.cdr.co at which you can easily access your code-server instance.
231231
Authorization is done via GitHub.
232232
`,
233-
beta: true,
233+
deprecated: true,
234234
},
235235
}
236236

@@ -253,7 +253,7 @@ export const optionDescriptions = (): string[] => {
253253
.map((line, i) => {
254254
line = line.trim()
255255
if (i === 0) {
256-
return " ".repeat(widths.long - k.length) + (v.beta ? "(beta) " : "") + line
256+
return " ".repeat(widths.long - k.length) + (v.deprecated ? "(deprecated) " : "") + line
257257
}
258258
return " ".repeat(widths.long + widths.short + 6) + line
259259
})

0 commit comments

Comments
 (0)