Skip to content

ci: build the overlay so type errors cannot ship - #67

Merged
Snehit70 merged 1 commit into
mainfrom
ci/build-overlay
Jul 15, 2026
Merged

Snehit70 merged 1 commit into
mainfrom
ci/build-overlay

Conversation

@Snehit70

@Snehit70 Snehit70 commented Jul 15, 2026 •

Copy link
Copy Markdown
Owner

The overlay is a separate npm project with its own tsconfig, so neither the root typecheck nor the test job covered it. A type error that broke its build outright reached main and shipped as v0.19.0 with CI reporting green throughout.

Its build is tsc && vite build, so building it in CI is what catches this.

Verified in a clean worktree (no pre-existing node_modules)

Test Result
npm install with Electron binary skipped 469 packages, ~1 min
npm run build on fixed code exit 0
npm run build on the offending commit d535653 exit 2

The step demonstrably fails on the regression that shipped, rather than merely passing on good code.

Electron's binary download is skipped — CI only typechecks and bundles the renderer, and never launches Electron.

Known limitation

The overlay has no lockfile, so this uses npm install rather than npm ci and is not fully reproducible. Committing a lockfile is a separate decision.

Summary by CodeRabbit

  • Tests
    • Extended automated validation to include the overlay component’s dependency installation and production build.
    • CI now verifies the overlay builds successfully before packaging and smoke tests proceed.

The overlay is a separate npm project with its own tsconfig, so neither the
root typecheck nor the test job covered it. A type error that broke its build
outright reached main and shipped as v0.19.0 with CI reporting green
throughout.

Its build is tsc && vite build, so building it in CI is what catches this.
Verified against the offending commit: the step exits 2 on d535653 and 0 once
fixed.

Electron's binary download is skipped - CI only typechecks and bundles the
renderer, and never launches Electron.

Note: the overlay has no lockfile, so this uses npm install rather than
npm ci and is not fully reproducible. Committing a lockfile is a separate
decision.
@coderabbitai

coderabbitai Bot commented Jul 15, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 49672d82-c264-4ed6-8508-81ad00540cb3

📥 Commits

Reviewing files that changed from the base of the PR and between dd0c365 and af3a1a3.

📒 Files selected for processing (1)
  • .github/workflows/test.yml

📝 Walkthrough

Walkthrough

The test workflow now installs dependencies for the overlay subproject with Electron downloads disabled and runs its build after the root typecheck and tests.

Changes

Overlay CI Validation

Layer / File(s) Summary
Overlay dependency installation and build
.github/workflows/test.yml
The test job installs overlay dependencies with Electron binary downloads skipped, then runs the overlay build before packaging and smoke tests.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main CI change: building the overlay to catch type errors before merge.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ci/build-overlay

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.

❤️ Share

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: af3a1a33b3

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


- name: Build overlay
working-directory: overlay
run: npm run build

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Fix the overlay build before adding it to CI

In the current tree this new step will make every PR/main test run fail: overlay/package.json defines build as tsc && vite build, and overlay/src/ipc-client.ts imports ./shared/ipc-types, but there is no overlay/src/shared file and overlay/tsconfig.json only includes src/**/* with no path mapping. I checked the repo-wide references to ipc-types; the only implementation is under the root src/shared, so the newly enforced tsc pass cannot resolve this module until the shared types are copied or the overlay project is wired to the root source correctly.

Useful? React with 👍 / 👎.

@Snehit70
Snehit70 merged commit 6c06a5f into main Jul 15, 2026
2 checks passed
@Snehit70
Snehit70 deleted the ci/build-overlay branch July 15, 2026 09:43
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.

1 participant