release/api-compatibility/go
A library checks its API against the previous release
Implements release/api-compatibility for go.
| Severity | info |
| Tiers | 1 |
| Stacks | go |
| Scope | root |
| Kind | outcome |
| Source | library v0.4.0 |
| Selected by | fleetlint-recommended@v0.4.0 |
Requirement
A Go module without a main package runs gorelease or apidiff against the previous tag.
Why
A breaking change in a minor release is found by every user at once; the check finds it before the tag.
Applies when
!exists("**/main.go")Fix
Run gorelease -base=$(git describe --tags --abbrev=0) in the release workflow.
Agent instruction: Add the stack’s API compatibility tool to the release workflow, comparing against the latest tag; on a breaking change bump the major version instead of silencing the tool.
Sources
- https://semver.org/spec/v2.0.0.html (standard)
- https://fleetlint.org/baseline/#releases (convention)
- https://pkg.go.dev/golang.org/x/exp/cmd/gorelease (spec)
- https://go.dev/doc/modules/version-numbers (guidance)
- https://fleetlint.org/stacks/#go
Generated by fleetlint docs from catalog v0.4.0.