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

deps/forks-documented/ruby

Forked or patched dependencies are documented

Implements deps/forks-documented for ruby.

Severityinfo
Tiers1, 2
Stacksruby
Scoperoot
Kindexpr
Sourcelibrary v0.4.0
Selected byfleetlint-recommended@v0.4.0

Requirement

A gem taken from git: or github: in the Gemfile 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("Gemfile", r'\b(git|github):\s').size() > 0

Check

For each item in:

grep("Gemfile", r'\b(git|github):\s').filter(l, !l.text.matches(r'\s#'))
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

Add docs/FORKS.md listing each forked or patched dependency with upstream, base version, the change and why, or comment each line.

Agent instruction: Document each forked or patched dependency (upstream, base version, change, reason) in docs/FORKS.md; ask the user for the reason where the history does not say.

Sources


Generated by fleetlint docs from catalog v0.4.0.