fleetlint Policy for a fleet of repositories
v0.5
Getting started

release/api-compatibility/go

A library checks its API against the previous release

Implements release/api-compatibility for go.

Severityinfo
Tiers1
Stacksgo
Scoperoot
Kindoutcome
Sourcelibrary v0.2.0
Selected byfleetlint-recommended@v0.2.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.

See: https://fleetlint.org/baseline/#releases, https://fleetlint.org/stacks/#go


Generated by fleetlint docs from catalog v0.2.0.