diff options
| author | Dan Willemsen <dwillemsen@google.com> | 2022-03-29 00:50:59 -0700 |
|---|---|---|
| committer | Dan Willemsen <dwillemsen@google.com> | 2022-03-29 00:52:27 -0700 |
| commit | f10932f763d058b0dcb3acfb795c869996fef47b (patch) | |
| tree | 7e04d345c214f3efac3c4b86c7ec3e831c500437 /gopls/README.md | |
| parent | d6d1ab63f7e2d16fb9a1f1d29755d12da90aa0bb (diff) | |
| parent | e693fb417253d14786976bd29a456961aa8b6343 (diff) | |
| download | golang-x-tools-f10932f763d058b0dcb3acfb795c869996fef47b.tar.gz | |
Merge commit 'e693fb417253d14786976bd29a456961aa8b6343'
Change-Id: I65e50880732e718fa2264e47ef7cc19e37cc2f05
Diffstat (limited to 'gopls/README.md')
| -rw-r--r-- | gopls/README.md | 27 |
1 files changed, 17 insertions, 10 deletions
diff --git a/gopls/README.md b/gopls/README.md index 85de62a1f..9afc2e48c 100644 --- a/gopls/README.md +++ b/gopls/README.md @@ -36,12 +36,9 @@ directory that is both outside of your `GOPATH` and outside of a module (a temp directory is fine), and run: ```sh -GO111MODULE=on go get golang.org/x/tools/gopls@latest +go install golang.org/x/tools/gopls@latest ``` -**NOTE**: Do not use the `-u` flag, as it will update your dependencies to -incompatible versions. - Learn more in the [advanced installation instructions](doc/advanced.md#installing-unreleased-versions). @@ -72,13 +69,21 @@ If you are having issues with `gopls`, please follow the steps described in the ## Supported Go versions and build systems -`gopls` follows the [Go Release -Policy](https://golang.org/doc/devel/release.html#policy), meaning that it -officially supports the last 2 major Go releases. Per +`gopls` follows the +[Go Release Policy](https://golang.org/doc/devel/release.html#policy), +meaning that it officially supports the last 2 major Go releases. Per [issue #39146](golang.org/issues/39146), we attempt to maintain best-effort support for the last 4 major Go releases, but this support extends only to not breaking the build and avoiding easily fixable regressions. +The following table shows the final gopls version that supports being built at +a given Go Version. Any more recent Go versions missing from this table can +still be built with the latest version of gopls. + +| Go Version | Final gopls Version With Support | +| ----------- | -------------------------------- | +| Go 1.12 | [gopls@v0.7.5](https://github.com/golang/tools/releases/tag/gopls%2Fv0.7.5) | + Our extended support is enforced via [continuous integration with older Go versions](doc/contributing.md#ci). This legacy Go CI may not block releases: test failures may be skipped rather than fixed. Furthermore, if a regression in @@ -86,9 +91,11 @@ an older Go version causes irreconcilable CI failures, we may drop support for that Go version in CI if it is 3 or 4 Go versions old. `gopls` currently only supports the `go` command, so if you are using a -different build system, `gopls` will not work well. Bazel support is currently -blocked on -[bazelbuild/rules_go#512](https://github.com/bazelbuild/rules_go/issues/512). +different build system, `gopls` will not work well. Bazel is not officially +supported, but Bazel support is in development (see +[bazelbuild/rules_go#512](https://github.com/bazelbuild/rules_go/issues/512)). +You can follow [these instructions](https://github.com/bazelbuild/rules_go/wiki/Editor-setup) +to configure your `gopls` to work with Bazel. ## Additional information |