Skip to content

build(docs): stop tracking generated search-index.json#995

Open
fayazg wants to merge 2 commits into
mainfrom
build/untrack-search-index
Open

build(docs): stop tracking generated search-index.json#995
fayazg wants to merge 2 commits into
mainfrom
build/untrack-search-index

Conversation

@fayazg

@fayazg fayazg commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Summary

  • apps/lfx-one/public/assets/docs/search-index.json is a build artifact, regenerated on every build by scripts/build-docs.mjs (via docs:build, chained into start, build, build:*, watch, and test, plus CI and Docker).
  • It was already covered by .gitignore (/public/assets/docs, added in feat(docs): public-facing user documentation portal at /docs #825), but the file was force-committed in that same PR — so it stayed tracked and produced diff churn on every build.
  • This removes it from the index with git rm --cached (file kept on disk); the ignore rule now takes effect, so builds no longer reintroduce tracked changes.
  • No .gitignore change needed — the rule was already present and correct. Sibling artifacts (dist-docs/, src/app/modules/docs/generated/) were already untracked; this brings search-index.json in line with them.

Signed-off-by: Fayaz G <5818912+fayazg@users.noreply.github.com>
@fayazg fayazg requested a review from a team as a code owner June 18, 2026 20:34
Copilot AI review requested due to automatic review settings June 18, 2026 20:34

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

💤 Files selected but had no reviewable changes (1)
  • apps/lfx-one/public/assets/docs/search-index.json
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 752d8d0b-fe8b-44d1-b005-8e1348b90c6f

📥 Commits

Reviewing files that changed from the base of the PR and between a8de077 and 610d4ca.

📒 Files selected for processing (1)
  • apps/lfx-one/public/assets/docs/search-index.json

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
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch build/untrack-search-index

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

@MRashad26 MRashad26 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review — PR #995 build/untrack-search-index

Verdict: PASS

Single-file housekeeping change. apps/lfx-one/public/assets/docs/search-index.json is a build artifact regenerated on every build by scripts/build-docs.mjs. It was accidentally force-committed in PR #825 alongside the .gitignore rule (/public/assets/docs) that was meant to exclude it. The ignore rule was already correct — the file just remained tracked, producing diff noise on every build.

This PR removes it from the index via git rm --cached (file kept on disk). Future builds regenerate it locally without it becoming a tracked change, consistent with the sibling artifacts (dist-docs/, src/app/modules/docs/generated/) which were already untracked.

Secrets check: Removed JSON is a MiniSearch index of public documentation pages only — no secrets or credentials.

Code standards: No Angular/TypeScript code changed — nothing to audit.

No issues found.

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.

3 participants