deps/forks-documented/python
Forked or patched dependencies are documented
Implements deps/forks-documented for python.
| Severity | info |
| Tiers | 1, 2 |
| Stacks | python |
| Scope | root |
| Kind | expr |
| Source | library v0.6.0 |
| Selected by | fleetlint-recommended@v0.6.0 |
Requirement
A git requirement in pyproject.toml or requirements*.txt 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("pyproject.toml", r'@ ?git\+').size() > 0 || grep("requirements*.txt", r'git\+').size() > 0Check
For each item in:
grep("pyproject.toml", r'@ ?git\+').filter(l, !l.text.matches(r'\s#')) + grep("requirements*.txt", r'git\+').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() > 0Fix
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
- https://fleetlint.org/baseline/#dependencies (convention)
- https://pip.pypa.io/en/stable/topics/vcs-support/ (spec)
- https://fleetlint.org/stacks/#python
Generated by fleetlint docs from catalog v0.6.0.