cmd/go: binary does not contain VCS information when compiled in git worktree dir #58218

rogpeppe · 2023-02-01T13:55:18Z

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

$ go version
go version go1.20rc3 linux/amd64

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="auto"
GOARCH="amd64"
GOBIN=""
GOCACHE="/home/rogpeppe/.cache/go-build"
GOENV="/home/rogpeppe/.config/go/env"
GOEXE=""
GOEXPERIMENT=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GOMODCACHE="/home/rogpeppe/src/go/pkg/mod"
GONOPROXY="github.com/influxdata/idpe"
GONOSUMDB="github.com/influxdata/idpe"
GOOS="linux"
GOPATH="/home/rogpeppe/src/go"
GOPRIVATE="github.com/influxdata/idpe"
GOPROXY="https://proxy.golang.org,direct"
GOROOT="/home/rogpeppe/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/home/rogpeppe/go/pkg/tool/linux_amd64"
GOVCS=""
GOVERSION="go1.20rc3"
GCCGO="gccgo"
GOAMD64="v1"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/home/rogpeppe/src/cuelabs/cue2/go.mod"
GOWORK=""
CGO_CFLAGS="-O2 -g"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-O2 -g"
CGO_FFLAGS="-O2 -g"
CGO_LDFLAGS="-O2 -g"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -Wl,--no-gc-sections -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build3009011258=/tmp/go-build -gno-record-gcc-switches"

What did you do?

Run testscript on the following file:

# set up git repository and build first binary
cd d1
exec git init
exec git add .
exec git commit -m 'initial commit'
exec go build -o $TMPDIR/prog1 .

# set up worktree and build second binary
exec git worktree add -b main1 ../d2 HEAD
cd ../d2
exec go build -o $TMPDIR/prog2 .

# ensure first binary has VCS info
exec go version -m $TMPDIR/prog1
stdout 'vcs.revision='

# ensure second binary has VCS info
exec go version -m $TMPDIR/prog2
stdout 'vcs.revision='

-- d1/go.mod --
module example

-- d1/main.go --
package main

func main() {}

What did you expect to see?

A successful test.

What did you see instead?

The binary built in a git worktree directory does not contain VCS information.
I suspect the logic doesn't understand that .git can be a file was well as a directory.

# set up git repository and build first binary (0.096s)
# set up worktree and build second binary (0.088s)
# ensure first binary has VCS info (0.002s)
# ensure second binary has VCS info (0.002s)
> exec go version -m $TMPDIR/prog2
[stdout]
$WORK/.tmp/prog2: go1.20rc3
	path	example
	mod	example	(devel)	
	build	-buildmode=exe
	build	-compiler=gc
	build	CGO_ENABLED=1
	build	CGO_CFLAGS=
	build	CGO_CPPFLAGS=
	build	CGO_CXXFLAGS=
	build	CGO_LDFLAGS=
	build	GOARCH=amd64
	build	GOOS=linux
	build	GOAMD64=v1
> stdout 'vcs.revision='
FAIL: /tmp/testscript498691614/x.txtar/script.txtar:19: no match for `vcs.revision=` found in stdout
error running /tmp/x.txtar in /tmp/testscript498691614/x.txtar

The text was updated successfully, but these errors were encountered:

mknyszek · 2023-02-01T15:13:31Z

CC @bcmills @matloob

mknyszek · 2023-02-01T15:14:15Z

Does this reproduce with earlier releases?

mvdan · 2023-02-01T15:18:23Z

It does; I have a fix ready. It's a rather simple one, we were just assuming that .git was always a directory in -buildvcs=auto.

gopherbot · 2023-02-01T15:22:53Z

Change https://go.dev/cl/463849 mentions this issue: cmd/go: support git worktree checkouts in -buildvcs=auto

tie · 2023-03-16T04:44:58Z

As mentioned in #58978 and #59068, this issue also affects work trees inside bare Git repositories where running git status --porcelain fails since it must be run in a work tree. That is, go build with VCS stamping (including auto mode) fails in such setup.

Go looks for .git, which is currently only allowed to be a directory.
Finds .git directory from the bare repository (see also git config core.bare).
Runs git status there, outside of the work tree.

gopherbot · 2023-03-30T18:43:21Z

Change https://go.dev/cl/480635 mentions this issue: cmd/gomote: don't push .git even if it is a file

In `git worktree` checkouts, rather than a .git directory, .git is a file containing the path of the real repository. Presence of this file will confuse git invoked by the go tool, so don't push it, just as we don't push a .git directory. For golang/go#58218. Change-Id: I2d316d5672a87ba9cb7175a07e06e99a3392a85d Reviewed-on: https://go-review.googlesource.com/c/build/+/480635 Reviewed-by: Carlos Amedee <amedee@google.com> Run-TryBot: Michael Pratt <mpratt@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Auto-Submit: Michael Pratt <mpratt@google.com>

Noticed while working on #371, but it appears that golangci-lint will sometimes hide errors that it *should* be showing if compiling succeeds. So if, hypothetically, you're impacted by golang/go#58218 and normally you're able to get by with 'go build -buildvcs=false ./...' but golangci-lint doesn't have that functionality, then this is able to reproduce on main.

cehoffman · 2024-02-29T20:33:45Z

Thanks for the start of the patch process @mvdan. I looked at the thread there, and I'm not sure what the remaining work is. Is the ask for a revert of the original logic change that broke worktrees with a regression test?

tie · 2024-03-01T21:44:27Z

@cehoffman, hi, I don’t think there is any work to do here aside from getting CL 463849 rebased, reviewed and merged, ideally also backported to stable release.

I’ve also added comments with regression test suggestions for my particular use case (i.e. bare Git repository with work trees), but that shouldn’t be that different from the regression test already present in the CL.

I’ve been using Go toolchain with GOFLAGS=-buildvcs=false because of this issue, so I’d appreciate if it finally gets resolved 😅

mknyszek added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. GoCommand cmd/go labels Feb 1, 2023

mknyszek added this to the Backlog milestone Feb 1, 2023

This was referenced Mar 11, 2023

cmd/go: git worktrees with gitdir ending in /.git no longer compile for some repos #58978

Closed

cmd/go: 1.20 broke buildvcs inside bare Git repositories with worktrees #59068

Closed

sharnoff mentioned this issue Oct 2, 2023

Fix some exhaustruct lints neondatabase/autoscaling#536

Merged

seankhliao mentioned this issue Dec 17, 2023

go build uses wrong VCS information when running in a git worktree #64772

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cmd/go: binary does not contain VCS information when compiled in git worktree dir #58218

cmd/go: binary does not contain VCS information when compiled in git worktree dir #58218

rogpeppe commented Feb 1, 2023

mknyszek commented Feb 1, 2023

mknyszek commented Feb 1, 2023

mvdan commented Feb 1, 2023

gopherbot commented Feb 1, 2023

tie commented Mar 16, 2023 •

edited

gopherbot commented Mar 30, 2023

cehoffman commented Feb 29, 2024

tie commented Mar 1, 2024

cmd/go: binary does not contain VCS information when compiled in git worktree dir #58218

cmd/go: binary does not contain VCS information when compiled in git worktree dir #58218

Comments

rogpeppe commented Feb 1, 2023

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

Does this issue reproduce with the latest release?

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

What did you do?

What did you expect to see?

What did you see instead?

mknyszek commented Feb 1, 2023

mknyszek commented Feb 1, 2023

mvdan commented Feb 1, 2023

gopherbot commented Feb 1, 2023

tie commented Mar 16, 2023 • edited

gopherbot commented Mar 30, 2023

cehoffman commented Feb 29, 2024

tie commented Mar 1, 2024

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

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

tie commented Mar 16, 2023 •

edited