From 6a2740f57ec6290548263191a90698c1eb295cc0 Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Mon, 29 Nov 2021 12:03:33 -0800 Subject: [PATCH] chore: add deprecation notice for --link (#4562) Co-authored-by: Joe Previte --- docs/README.md | 4 ---- docs/link.md | 4 +++- src/node/cli.ts | 8 ++++---- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index 58e00397..9c3ae36d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 diff --git a/docs/link.md b/docs/link.md index 7b21244c..8bef6bb6 100644 --- a/docs/link.md +++ b/docs/link.md @@ -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 diff --git a/src/node/cli.ts b/src/node/cli.ts index 388cf855..31ad9a1c 100644 --- a/src/node/cli.ts +++ b/src/node/cli.ts @@ -104,9 +104,9 @@ interface Option { 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 extends boolean @@ -230,7 +230,7 @@ const options: Options> = { https://hostname-username.cdr.co at which you can easily access your code-server instance. Authorization is done via GitHub. `, - beta: true, + deprecated: true, }, } @@ -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 })