docs(readme): note govulncheck/golangci-lint install to GOPATH/bin - #711
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughREADME.md clarifies where ChangesGo tool setup documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 378-383: Update the README installation-path example to use Go’s
configured GOBIN when set, falling back to $(go env GOPATH)/bin, and make the
PATH update idempotent so rerunning the command does not append the same
directory repeatedly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
The installed binaries land in $GOPATH/bin (default ~/go/bin), which must be on PATH to run govulncheck directly. Document the export snippet so the lint/security tooling from the contributor setup actually resolves.
fbf8020 to
f992a3b
Compare
Vasanthdev2004
left a comment
Vasanthdev2004
left a comment
There was a problem hiding this comment.
Docs-only change to README.md: notes that go install places binaries in $GOPATH/bin and shows how to add it to PATH. Build and vet are clean, and the added snippet (export PATH="$PATH:$(go env GOPATH)/bin") is correct and portable. Tiny wording nit, not worth blocking on: the sentence singles out "to run govulncheck directly" when the same applies to golangci-lint installed just above — "to run them directly" would be slightly more accurate. Approving.
golangci-lint installs to the same $GOPATH/bin as govulncheck, so the PATH note applies to both, not just the one named. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Vasanthdev2004
left a comment
Vasanthdev2004
left a comment
There was a problem hiding this comment.
Re-approving. This is the wording fix I asked for last round: it now says "run them directly" instead of singling out govulncheck, which reads right since golangci-lint installs to the same GOPATH/bin. Docs-only, nothing else to flag.
go install writes to GOBIN when set, with GOPATH/bin as the fallback, and rerunning the old snippet appended the same directory repeatedly. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Pushed 8671f7c: the install-path snippet now honors GOBIN with a $(go env GOPATH)/bin fallback, and the PATH update is guarded so rerunning it doesn't append duplicates (verified idempotent). |
|
Ready for review. Docs-only PATH/GOBIN note. CI is green; CodeRabbit approved. No open review threads. |
3 participants
Summary
The contributor setup in
README.mdtells readers togo installgolangci-lintandgovulncheck, but does not mention that the resulting binaries land in$GOPATH/bin(default~/go/bin). If that directory is not already onPATH, the tools cannot be run directly, which silently breaks the documented lint/security workflow. This adds a short note and anexport PATHsnippet so the tooling actually resolves.Changes
README.md(contributor/lint-tooling section): document that installed binaries go to$GOPATH/bin, and add a copy-pasteexport PATH="$PATH:$(go env GOPATH)/bin"snippet.Test plan
make lintandgovulncheck ./...resolve after adding$(go env GOPATH)/bintoPATH.Summary by CodeRabbit
govulncheck) are placed, including the default~/go/binwhen$GOBINisn’t set.PATH, with a shell snippet to set it if needed.