Skip to content

chore: add deprecation notice for --link #4562

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 29, 2021
Merged

chore: add deprecation notice for --link #4562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e2ec79
chore: add deprecation notice for --link
bpmct Nov 29, 2021
9ad76d7
Merge branch 'main' into bpmct/depricate-link
jsjoeio Nov 29, 2021
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
4 changes: 0 additions & 4 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,6 @@ code-server.
We also have an in-depth [setup and
configuration](https://coder.com/docs/code-server/latest/guide) guide.

## TLS and authentication (beta)

To add TLS and authentication out of the box, use [code-server --link](https://coder.com/docs/code-server/latest/link).

## Questions?

See answers to [frequently asked
Expand Down
4 changes: 3 additions & 1 deletion docs/link.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# code-server --link

Run code-server with the beta flag `--link` and you'll get TLS, authentication, and a dedicated URL
> Note: This feature is no longer recommended due to instability. Stay tuned for a revised version.

Run code-server with the flag `--link` and you'll get TLS, authentication, and a dedicated URL
for accessing your IDE out of the box.

```console
Expand Down
8 changes: 4 additions & 4 deletions src/node/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ interface Option<T> {
description?: string

/**
* If marked as beta, the option is marked as beta in help.
* If marked as deprecated, the option is marked as deprecated in help.
*/
beta?: boolean
deprecated?: boolean
}

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

Expand All @@ -253,7 +253,7 @@ export const optionDescriptions = (): string[] => {
.map((line, i) => {
line = line.trim()
if (i === 0) {
return " ".repeat(widths.long - k.length) + (v.beta ? "(beta) " : "") + line
return " ".repeat(widths.long - k.length) + (v.deprecated ? "(deprecated) " : "") + line
}
return " ".repeat(widths.long + widths.short + 6) + line
})
Expand Down