Add release tagger tool #7230
Add release tagger tool #7230
Conversation
- Creates both main repository tags and submodule tags - Integrates with existing make-based build system - Automatically discovers all Go submodules - Provides consistent tagging across mono-repo
jakobht
requested review from
Shaddoll,
neil-xie,
davidporter-id-au,
Groxx,
shijiesheng,
3vilhamster,
sankari165,
dkrotx,
taylanisikdemir and
demirkayaender
as code owners
cadence-releasetagger
Outdated
There was a problem hiding this comment.
I wonder if there's a way to tell git to ignore executable files by default
There was a problem hiding this comment.
Ooops - deleted and added to gitigonore
| for _, line := range strings.Split(goListOutput, "\n") { | ||
| parts := strings.Split(line, "\t") | ||
| if len(parts) != 2 { | ||
| continue | ||
| } | ||
| modulePath, moduleDir := parts[0], parts[1] | ||
|
|
||
| if strings.HasPrefix(modulePath, mainModule+"/") { | ||
| relPath, err := filepath.Rel(root, moduleDir) | ||
| if err != nil { | ||
| return "", fmt.Errorf("error getting relative path for %s: %v", moduleDir, err) | ||
| } | ||
| tags = append(tags, fmt.Sprintf("%s/%s", relPath, version)) | ||
| } | ||
| } |
There was a problem hiding this comment.
frustratingly hard in bash, yea. tbh I think minor go scripts like this are reasonable, and they have the extreme benefit of being far more likely to be cross-platform by accident.
There was a problem hiding this comment.
IMO anything that has branching, loops or string processing should not be written in bash - it becomes impossible to read so fast.
| } | ||
| version := os.Args[1] | ||
|
|
||
| cmd := exec.Command("go", "list", "-m", "-f", "{{.Path}}\t{{.Dir}}", "all") |
There was a problem hiding this comment.
I think this is probably fine to use, but as an fyi: this can probably trigger downloads and be kinda slow. might want to limit it to like 1s and give up (and print stderr) if it takes too long.
(it does not appear to need the modules to be downloaded, but it could still trigger e.g. a go-toolchain download-and-install during which it'll just hang silently)
that said: I suppose this probably is the canonically correct way to get this info 🤔 tags need to be based on the relative path, not whatever the module names happen to be, so 👍 https://go.dev/doc/modules/managing-source#multiple-module-source
| BINS += cadence-releasetagger | ||
| cadence-releasetagger: $(BINS_DEPEND_ON) | ||
| $Q echo "compiling cadence-releasetagger with OS: $(GOOS), ARCH: $(GOARCH)" | ||
| $Q go build -o $@ cmd/tools/releasetagger/main.go |
There was a problem hiding this comment.
if you do end up using x/mod/semver, this is likely better as
$(BIN)/releasetagger: internal/tools/go.mod $(wildcard internal/tools/releasetagger/*) | $(BIN)
$(call go_build_tool,./releasetagger)
as that way it'll rebuild on go / mod changes.
as long as it's just stdlib it doesn't really matter what builds it though.
| fmt.Println("Usage: go run main.go <version>") | ||
| os.Exit(1) | ||
| } | ||
| version := os.Args[1] |
There was a problem hiding this comment.
probably worth doing a https://pkg.go.dev/golang.org/x/mod/semver#IsValid check to make sure it's a valid semver?
What changed?
Added a new
cadence-releasetaggertool and correspondingmake tag-releasetarget that generates git tag commands for both the main repository and all Go submodules.The tool automatically discovers all Go modules in the repository and creates appropriately namespaced tags:
v1.2.3cmd/server/v1.2.3,common/archiver/gcloud/v1.2.3, etc.Usage:
Why?
This makes it easy to tag all submodules so we can refer to them with proper versioning.
Go's module system supports both main and submodule tags for proper semantic versioning in repos with more than one module. See Go Modules Reference for details on submodule versioning.
How did you test it?
Tested with sample versions:
./cadence-releasetagger v1.5.0-testVerified output includes both main and submodule tags
Example output:
Potential risks
Very low risk - this is a code generation tool that only outputs git commands. It doesn't execute anything automatically.
Release notes
Documentation Changes