chore(tools): stop tracking the changelog-site build output - #2192
Conversation
tools/changelog-site/changelog-site is a compiled executable that was committed next to main.go by accident. Building the tool in that directory rewrote the tracked file and left a 4 MB change in git status. Remove it from the index and ignore it, matching tools/ci-health. Update the check-go-tools comment that described the committed binary. Fixes NVIDIA#1240 Signed-off-by: Rajat Patra <rajatkk.patra@gmail.com>
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. Important Review skippedWe couldn't safely recover the incremental review. No full review was started, and the last reviewed checkpoint was preserved. Retry later, or explicitly request a full review by commenting You can disable this status message by setting the Use the checkbox below for a quick retry:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: NVIDIA/nvcf/.coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (3)
Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review. 📝 WalkthroughWalkthroughThe changelog-site ignore file now documents and ignores ChangesChangelog-site build output
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~4 minutes Change: Other · Severity of issue fixed: Low Merge Risk: ⚪ Minimal · up to The change removes tracked build output without changing the documented tool invocation or CI build behavior. No actionable merge-blocking issue is established. 🚥 Pre-merge checks | ✅ 4 | ❓ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
Full details: Linked Issues checkExplanation The PR satisfies the main coding changes in issue ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
TL;DR
Stop tracking the
tools/changelog-site/changelog-sitebuild output and ignore it, so building the tool locally no longer produces a 4 MB change ingit status.Additional Details (optional for docs, build, test, refactor, ci, chore, style, and revert PRs)
tools/changelog-site/changelog-siteis a compiled x86-64 executable (4,275,095 bytes) that was committed next tomain.goby accident. Runninggo buildin that directory rewrites the tracked file, and every rebuild that gets committed adds another 4 MB blob to history.This PR:
git rm --cached).tools/changelog-site/.gitignore, matching the existingtools/ci-health/.gitignorefor the same situation.tools/ci/check-go-toolsthat described the committed binary, since it no longer applies.The issue asked to confirm nothing runs the committed binary directly. What I could check from the public tree:
git grep changelog-siteoutside the tool directory finds only thecheck-go-toolscomment. Nothing runs./changelog-siteor references a Bazel target for it.go run -C tools/changelog-site ..go version -mon the committed file shows a localgo build(linux/amd64,CGO_ENABLED=1, not stripped, no-trimpath), which looks like a developer build rather than a CI artifact.For the Reviewer
The README says the
pagesjob runs this tool on default-branch pipelines. That job's config is not in the public tree, so I could not check it. Please confirm it builds orgo runs the tool rather than executing the committed file. If it does execute the file, it needs a build step before this merges.For QA (optional for docs, build, test, refactor, ci, chore, style, and revert PRs)
go build -C tools/changelog-site -o changelog-site .thengit status: the rebuilt binary is ignored and no longer shows as modified.git check-ignore -v tools/changelog-site/changelog-sitematches the new.gitignore.go test -C tools/changelog-site ./...passes.git diff --checkis clean.QA not needed.
Issues
Fixes #1240
Checklist
Summary by CodeRabbit