diff options
author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2020-03-16 10:26:31 +0000 |
---|---|---|
committer | GitHub <[email protected]> | 2020-03-16 10:26:31 +0000 |
commit | 200c275c2e9955371e61f6ad7684084655df46fc (patch) | |
tree | c4b61de644cec37cffca9010d56afc4136d23ca8 /docs/user/readme.adoc | |
parent | a99cac671c3e6105a0192acbb1a91cb83e453018 (diff) | |
parent | 5a0041c5aaeee49be84ce771fb0360ae55cbd8b2 (diff) |
Merge #3534
3534: Feature: vscode impl nightlies download and installation r=Veetaha a=Veetaha
I need to test things more, but the core shape of the code is quite well-formed.
The main problem is that we save the release date only for nightlies and there are no means to get the release date of the stable extension (i.e. for this we would need to consult the github releases via a network request, or we would need to somehow save this info into package.json or any other file accessible from the extension code during the deployment step, but this will be very hard I guess).
So there is an invariant that the users can install nightly only from our extension and they can't do it manually, because when installing the nightly `.vsix` we actually save its release date to `globalState`
Closes: #3402
TODO:
- [x] More manual tests and documentation
cc @matklad @lnicola
Co-authored-by: Veetaha <[email protected]>
Co-authored-by: Veetaha <[email protected]>
Diffstat (limited to 'docs/user/readme.adoc')
-rw-r--r-- | docs/user/readme.adoc | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc index 4e99dd0a6..2e6c6112f 100644 --- a/docs/user/readme.adoc +++ b/docs/user/readme.adoc | |||
@@ -65,6 +65,25 @@ Note that we only support the latest version of VS Code. | |||
65 | 65 | ||
66 | The extension will be updated automatically as new versions become available. It will ask your permission to download the matching language server version binary if needed. | 66 | The extension will be updated automatically as new versions become available. It will ask your permission to download the matching language server version binary if needed. |
67 | 67 | ||
68 | ===== Nightly | ||
69 | |||
70 | We ship nightly releases for VS Code. To help us out with testing the newest code and follow the bleeding edge of our `master`, please use the following config: | ||
71 | |||
72 | [source,json] | ||
73 | ---- | ||
74 | { "rust-analyzer.updates.channel": "nightly" } | ||
75 | ---- | ||
76 | |||
77 | You will be prompted to install the `nightly` extension version. Just click `Download now` and from that moment you will get automatic updates each 24 hours. | ||
78 | |||
79 | If you don't want to be asked for `Download now` every day when the new nightly version is released add the following to your `settings.json`: | ||
80 | [source,json] | ||
81 | ---- | ||
82 | { "rust-analyzer.updates.askBeforeDownload": false } | ||
83 | ---- | ||
84 | |||
85 | NOTE: Nightly extension should **only** be installed via the `Download now` action from VS Code. | ||
86 | |||
68 | ==== Building From Source | 87 | ==== Building From Source |
69 | 88 | ||
70 | Alternatively, both the server and the plugin can be installed from source: | 89 | Alternatively, both the server and the plugin can be installed from source: |