Skip to content

chore(tools): stop tracking the changelog-site build output - #2192

Merged
sbaum1994 merged 2 commits into
NVIDIA:mainfrom
RawJat:rawjat/fix/untrack-changelog-site-binary
Oct 1, 2026
Merged

sbaum1994 merged 2 commits into
NVIDIA:mainfrom
RawJat:rawjat/fix/untrack-changelog-site-binary

Conversation

@RawJat

@RawJat RawJat commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

TL;DR

Stop tracking the tools/changelog-site/changelog-site build output and ignore it, so building the tool locally no longer produces a 4 MB change in git status.

Additional Details (optional for docs, build, test, refactor, ci, chore, style, and revert PRs)

tools/changelog-site/changelog-site is a compiled x86-64 executable (4,275,095 bytes) that was committed next to main.go by accident. Running go build in that directory rewrites the tracked file, and every rebuild that gets committed adds another 4 MB blob to history.

This PR:

  • Removes the binary from the index (git rm --cached).
  • Adds tools/changelog-site/.gitignore, matching the existing tools/ci-health/.gitignore for the same situation.
  • Updates the comment in tools/ci/check-go-tools that 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-site outside the tool directory finds only the check-go-tools comment. Nothing runs ./changelog-site or references a Bazel target for it.
  • The tool README runs it with go run -C tools/changelog-site ..
  • go version -m on the committed file shows a local go 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 pages job 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 or go 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 . then git status: the rebuilt binary is ignored and no longer shows as modified.
  • git check-ignore -v tools/changelog-site/changelog-site matches the new .gitignore.
  • go test -C tools/changelog-site ./... passes.
  • git diff --check is clean.

QA not needed.

Issues

Fixes #1240

Checklist

  • I am familiar with the Contributing Guidelines.
  • I have signed off my commits for Developer Certificate of Origin (DCO) compliance.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

Summary by CodeRabbit

  • Chores
    • Ignored the changelog site’s build output directory.
    • Updated a comment about where Go build outputs are left; build behavior is unchanged.

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>
@RawJat
RawJat requested a review from a team as a code owner September 30, 2026 22:04
@RawJat
RawJat requested a review from Max-NV September 30, 2026 22:04
@coderabbitai

coderabbitai Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Important

Review skipped

We 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 @coderabbitai full review.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: NVIDIA/nvcf/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: d6d23a70-1373-4fda-8b7b-b9c05e5456df

📥 Commits

Reviewing files that changed from the base of the PR and between 543a198 and 9753f15.

📒 Files selected for processing (3)
  • tools/changelog-site/.gitignore
  • tools/changelog-site/changelog-site
  • tools/ci/check-go-tools

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.


📝 Walkthrough

Walkthrough

The changelog-site ignore file now documents and ignores /changelog-site. A comment in the Go tools check now says build output remains in the source tree and no longer mentions rewriting a committed binary.

Changes

Changelog-site build output

Layer / File(s) Summary
Ignore rule and build-output comment
tools/changelog-site/.gitignore, tools/ci/check-go-tools
The ignore file documents and ignores /changelog-site. The CI script comment no longer says that building rewrites a committed binary.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Other · Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to 9753f

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)

Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The PR satisfies the main coding changes in issue #1240. It deletes the tracked tools/changelog-site/changelog-site executable and ignores /changelog-site in tools/changelog-site/.gitignore. The… Provide reviewable evidence that the pages job does not execute tools/changelog-site/changelog-site directly, or clarify the job configuration so this condition can be decided.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title follows Conventional Commits syntax and accurately describes the repository-maintenance change that stops tracking the changelog-site build output.
Out of Scope Changes check ✅ Passed The PR changes only the tracked build output, its ignore rule, and the related tools/ci/check-go-tools comment. These changes directly support issue #1240 by preventing tracked rebuild output and ke…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Linked Issues check

Explanation

The PR satisfies the main coding changes in issue #1240. It deletes the tracked tools/changelog-site/changelog-site executable and ignores /changelog-site in tools/changelog-site/.gitignore. The reported build and test checks support the change. The issue also asks for confirmation that no pages job invokes the committed path directly. The available evidence reports no public-tree caller but does not establish the behavior of that job.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Comment @coderabbitai help to get the list of available commands.

@sbaum1994
sbaum1994 enabled auto-merge October 1, 2026 21:10
@sbaum1994
sbaum1994 added this pull request to the merge queue Oct 1, 2026
Merged via the queue into NVIDIA:main with commit 07ed3e6 Oct 1, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

tools/changelog-site: a compiled binary is committed to the repository

2 participants