deps/forks-documented/go
Forked or patched dependencies are documented
Implements deps/forks-documented for go.
| Severity | info |
| Tiers | 1, 2 |
| Stacks | go |
| Scope | root |
| Kind | expr |
| Source | library v0.8.0 |
| Selected by | fleetlint-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() > 0Check
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() > 0Fix
This implementation has no fix of its own: see deps/forks-documented.
Sources
- https://fleetlint.org/baseline/#dependencies (convention)
- https://go.dev/ref/mod (spec, replace directive)
- https://fleetlint.org/stacks/#go
Generated by fleetlint docs from catalog v0.8.0.