fleetlint Policy for a fleet of repositories
v0.11 (latest)
Getting started

deps/forks-documented/go

Forked or patched dependencies are documented

Implements deps/forks-documented for go.

Severityinfo
Tiers1, 2
Stacksgo
Scoperoot
Kindexpr
Sourcelibrary v0.8.0
Selected byfleetlint-recommended@v0.8.0

Requirement

A go.mod replace pointing at another module (a local path such as => ../x is a sibling module, not a fork) is documented in FORKS.md or a Forks section, or carries a // comment on the line.

Why

A fork without a note outlives the reason for it; the next upgrade either drops the fix or keeps the fork forever.

Applies when

grep("go.mod", r'=>\s*[a-z]').size() > 0

Check

For each item in:

grep("go.mod", r'=>\s*[a-z]').filter(l, !l.text.contains("//"))
exists("FORKS.md") || exists("docs/FORKS.md") || exists("docs/forks.md") || grep("README.md", r'^#+ .*\b(forks?|vendored|patched|patches)\b').size() > 0 || grep("docs/**/*.md", r'^#+ .*\b(forks?|vendored|patched|patches)\b').size() > 0

Fix

This implementation has no fix of its own: see deps/forks-documented.

Sources


Generated by fleetlint docs from catalog v0.8.0.