golang/go

all: CI's enforcement of clean `go generate` is lacking

Open

#70954 opened on Dec 21, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Go (133,883 stars) (19,008 forks)batch import
NeedsInvestigationhelp wanted

Description

Go version

go version devel go1.24-110ab1aaf4 Sat Dec 21 08:22:08 2024 -0800 linux/amd64

Output of go env in your module/workspace:

AR='ar'
CC='gcc'
CGO_CFLAGS='-O2 -g'
CGO_CPPFLAGS=''
CGO_CXXFLAGS='-O2 -g'
CGO_ENABLED='1'
CGO_FFLAGS='-O2 -g'
CGO_LDFLAGS='-O2 -g'
CXX='g++'
GCCGO='gccgo'
GO111MODULE=''
GOAMD64='v3'
GOARCH='amd64'
GOAUTH='netrc'
GOBIN=''
GOCACHE='/tmp/go-build'
GODEBUG=''
GOENV='/home/hugo/.config/go/env'
GOEXE=''
GOEXPERIMENT=''
GOFIPS140='off'
GOFLAGS=''
GOGCCFLAGS='-fPIC -m64 -pthread -Wl,--no-gc-sections -fmessage-length=0 -ffile-prefix-map=/tmp/go-build610608568=/tmp/go-build -gno-record-gcc-switches'
GOHOSTARCH='amd64'
GOHOSTOS='linux'
GOINSECURE=''
GOMOD='/home/hugo/k/go/src/go.mod'
GOMODCACHE='/home/hugo/go/pkg/mod'
GONOPROXY=''
GONOSUMDB=''
GOOS='linux'
GOPATH='/home/hugo/go'
GOPRIVATE=''
GOPROXY='https://proxy.golang.org,direct'
GOROOT='/home/hugo/k/go'
GOSUMDB='sum.golang.org'
GOTELEMETRY='local'
GOTELEMETRYDIR='/home/hugo/.config/go/telemetry'
GOTMPDIR=''
GOTOOLCHAIN='local'
GOTOOLDIR='/home/hugo/k/go/pkg/tool/linux_amd64'
GOVCS=''
GOVERSION='devel go1.24-110ab1aaf4 Sat Dec 21 08:22:08 2024 -0800'
GOWORK=''
PKG_CONFIG='pkg-config'

What did you do?

In the go repo:

cd src
./make.bash
cd internal/goexperiment/ && go generate .
git status

What did you see happen?

On branch master
Your branch is up to date with 'origin/master'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	exp_synctest_off.go
	exp_synctest_on.go

nothing added to commit but untracked files present (use "git add" to track)

What did you expect to see?

On branch master
Your branch is up to date with 'origin/master'.

nothing to commit, working tree clean

Contributor guide

Tech stack
go
Domain
build systemci cd
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programminggo generateCI/CD practices
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Examine the go generate commands in src/internal/goexperiment/. Check if the generated files are supposed to be committed or generated at build time. Look at the CI configuration (e.g., .github/workflows) to see if there is a step to verify that go generate is clean. The issue suggests that the CI lacks enforcement, so a possible fix could be to add a check in CI that runs go generate and fails if there are uncommitted changes. Alternatively, the generation script might need to include the missing files.