Skip to content
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.

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

Jump to bottom

x/tools/gopls: do not include replace directive in release versions #42627

Closed
myitcv opened this issue Nov 16, 2020 · 2 comments
Closed

x/tools/gopls: do not include replace directive in release versions #42627

myitcv opened this issue Nov 16, 2020 · 2 comments
Labels
FrozenDueToAge gopls Issues related to the Go language server, gopls. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
vscode-go: gopls by default
Milestone
gopls/v0.5.4

Comments

@myitcv
Copy link
Member

myitcv commented Nov 16, 2020

What version of Go are you using (go version)?

$ go version
go version devel +7307e86afd Sun Nov 8 12:19:55 2020 +0000 linux/amd64
$ go list -m golang.org/x/tools
golang.org/x/tools v0.0.0-20201102212025-f46e4245211d
$ go list -m golang.org/x/tools/gopls
golang.org/x/tools/gopls v0.0.0-20201102212025-f46e4245211d

Does this issue reproduce with the latest release?

Yes

What operating system and processor architecture are you using (go env)?

go env Output
$ go env
GO111MODULE=""
GOARCH="amd64"
GOBIN=""
GOCACHE="/home/myitcv/.cache/go-build"
GOENV="/home/myitcv/.config/go/env"
GOEXE=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GOMODCACHE="/home/myitcv/gostuff/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="linux"
GOPATH="/home/myitcv/gostuff"
GOPRIVATE=""
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/home/myitcv/gos"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/home/myitcv/gos/pkg/tool/linux_amd64"
GCCGO="gccgo"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/home/myitcv/.vim/plugged/govim/go.mod"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build946386886=/tmp/go-build -gno-record-gcc-switches"

What did you do?

Putting together a Play with Go guide on how to use the new go install $pkg@$version in Go 1.16 with @mvdan (https://play-with-go.dev/installing-go-programs-directly_go116_en/), we had hoped to be able to use gopls as our canonical example of a Go program. However:

$ go install golang.org/x/tools/gopls@v0.5.3
go install golang.org/x/tools/gopls@v0.5.3: golang.org/x/tools/gopls@v0.5.3
    The go.mod file for the module providing named packages contains one or
    more replace directives. It must not contain directives that would cause
    it to be interpreted differently than if it were the main module.

This is as a result of:

https://github.com/golang/tools/blob/ae6603bdc3c4d025cb6c000c3b8dd778b1355266/gopls/go.mod#L14

What did you expect to see?

gopls install successfully.

What did you see instead?

As above.

The current guidance is that release versions of modules should not include replace directives:

https://go.googlesource.com/proposal/+/refs/changes/77/243077/15/design/40276-go-install.md#why-can_t-directory-directives-be-used

Also referencing #26640 for context.

@stamblerre

cc @jayconrod
@myitcv myitcv added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. gopls Issues related to the Go language server, gopls. labels Nov 16, 2020
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label Nov 16, 2020
@gopherbot gopherbot added this to the Unreleased milestone Nov 16, 2020
@mvdan
Copy link
Member

mvdan commented Nov 16, 2020

100% agree - gopls is probably the first module most newcomers to Go have to install, so it's unfortunate that it doesn't follow our own best practices and go install [...]@latest does not work.

Thinking outloud, and as an extension to this issue, it would also be unfortunate for @latest to work, but @master to fail, if we simply remove the replace directives from tagged releases. Though I don't think we can make go install [...]@master work today easily, as that would require a feature like #26640.

@stamblerre stamblerre modified the milestones: Unreleased, gopls/v0.5.4 Nov 16, 2020
@gopherbot
Copy link

Change https://golang.org/cl/272688 mentions this issue: [gopls-release-branch.0.5] gopls: remove replace from release branch

gopherbot pushed a commit to golang/tools that referenced this issue Nov 24, 2020
@stamblerre
[gopls-release-branch.0.5] gopls: remove replace from release branch
30bfc3f 
Updates golang/go#42627

Change-Id: Ibd868e9c65fd480f003468dc7e97814e584d6065
Reviewed-on: https://go-review.googlesource.com/c/tools/+/272688
Trust: Rebecca Stambler <rstambler@golang.org>
Run-TryBot: Rebecca Stambler <rstambler@golang.org>
Reviewed-by: Robert Findley <rfindley@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
@stamblerre stamblerre added this to Needs Triage in vscode-go: gopls by default Nov 25, 2020
vscode-go: gopls by default automation moved this from Needs Triage to Done Nov 30, 2020
@komem3 komem3 mentioned this issue Mar 19, 2021
Closed
@killianmuldoon killianmuldoon mentioned this issue Sep 2, 2021
Closed
@golang golang locked and limited conversation to collaborators Nov 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge gopls Issues related to the Go language server, gopls. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
No open projects
vscode-go: gopls by default
  
Done
Milestone
gopls/v0.5.4
Development

No branches or pull requests
4 participants
@myitcv @mvdan @stamblerre @gopherbot