beads/docs/LINTING.md
Julian Knutsen 9e8d411f71
Add PR CI wrapper command surface (#4211)
* ci: add PR wrapper command surface

* ci: collect wrapper timing in PR checks

* docs: record initial CI wrapper measurements

* ci: add manual measurement workflow

* ci: allow branch measurement dispatch

* ci: keep measuring independent commands after failures

* docs: record branch-dispatched CI measurement

* ci: keep measuring package suites after failures

* docs: record CI measurement batch

* fix: repair CI-measured test failures

* test: make local Go gates hermetic

* ci: add sharded integration measurement lane

* test: fix internal beads integration TestMain

* docs: record fixed integration shard measurement

* ci: add hybrid integration sharding measurement

* ci: speed up cmd/bd test shard discovery

* ci: add 16-way integration sharding measurement

* ci: measure prebuilt cmd bd sharding

* docs: record prebuilt sharding measurement

* docs: design CI build artifact stage

* docs: record repeat prebuilt integration measurement

* ci: add build artifact stage

* ci: reuse build artifact in linux test lane

* ci: promote main linux integration shards

* ci: gate legacy platform tests to main

* ci: satisfy workflow shell lint

* ci: ignore archived migrations in duplicate check

* ci: add package gate wrappers

* test: clean up testing short boundaries

* ci: allow unreleased version docs lag

* ci: gate releases on package checks

* ci: split workflow by tier

* ci: add aggregate PR gates
2026-05-29 18:52:53 -07:00

1.9 KiB

Linting Policy

Last reviewed: 2026-05-29

Freshness source: .golangci.yml, .github/workflows/pr.yml, .github/workflows/main.yml, and golangci-lint run --timeout=5m --build-tags=gms_pure_go ./... returning zero issues.

This document explains the required Go lint gate for this codebase.

Current Status

Lint is a required CI gate. The PR and main workflows run golangci-lint with the repository configuration and --build-tags=gms_pure_go; it is expected to pass with zero issues.

Run the same check locally with:

golangci-lint run --timeout=5m --build-tags=gms_pure_go ./...

Formatting is a separate required gate:

make fmt-check

Policy

Treat new lint findings as defects to fix before merge. Do not add a tolerated failing baseline, and do not configure CI with --issues-exit-code=0.

When a linter reports an intentional or false-positive pattern:

  • Prefer a narrow .golangci.yml exclusion tied to a path, linter, and message.
  • Use //nolint:<linter> only when the reason is local to a specific line and the comment explains why the warning is not actionable.
  • Keep broad linter disables as a last resort.

The current configuration already encodes accepted exclusions for intentional patterns such as deferred cleanup errors, controlled subprocess execution, test-fixture file reads, and documented security false positives.

CI Cleanup Decision

pr-lint should stay separate from pr-policy and pr-core so failures are easy to identify and rerun. It should include:

  • make fmt-check
  • golangci-lint run --timeout=5m --build-tags=gms_pure_go ./...

See CI_CLEANUP_PLAN.md for the full CI tier policy.

Future Work

  • Pin the golangci-lint version in CI instead of using version: latest.
  • Move the final CI shape behind a repository-owned scripts/ci/pr-lint.sh wrapper.
  • Periodically audit .golangci.yml exclusions and remove entries that are no longer needed.