You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
ci: skip Electron's binary download in CI, release and docs installs - #89
The first daily release (run 42471100534, 8 November) failed before publishing 0.9.5, and its re-run failed the same way: npm install runs Electron's install script, which downloads the Electron binary from GitHub's release servers, and those answered the runners with 504 Gateway Time-out in the build, postgres18 and browser jobs.
No job launches Electron. The package is a dev dependency for its types, and the tests that reach the Electron adapters mock the electron module. This change sets ELECTRON_SKIP_BINARY_DOWNLOAD=1 at the top of ci.yml, release.yml and pages-typedoc.yml, so installs no longer depend on that download.
Linked issues
No issue
Spec, plan and design
None
Pictures
No visible change
Type of change
Build or CI
How this was verified
This pull request runs the whole suite (build, postgres18, browser) with the variable set; a test that needed the binary would fail here. After the merge, a release dispatch publishes 0.9.5.
Migration notes
None
Summary by CodeRabbit
Chores
Updated automated checks, documentation publishing, and release workflows to skip downloading Electron binaries.
Set ELECTRON_SKIP_BINARY_DOWNLOAD=1 across CI, release, and documentation workflows so installs do not depend on downloading an Electron binary that no job uses.
.github/workflows/ci.yml L20-25
.github/workflows/pages-typedoc.yml L16-21
.github/workflows/release.yml L37-42
Tips and commands
Interacting with Sourcery
Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment @sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment @sourcery-ai review to trigger a new review!
No actionable comments were generated in the recent review.
Walkthrough
The CI, Pages, and release workflows now set ELECTRON_SKIP_BINARY_DOWNLOAD to 1. The Pages and release workflows also add comments about Electron and its binary-download script.
Changes: Workflow Install Configuration
Layer / File(s)
Summary
Set Electron download environment variable .github/workflows/ci.yml, .github/workflows/pages-typedoc.yml, .github/workflows/release.yml
All three workflows set ELECTRON_SKIP_BINARY_DOWNLOAD to 1. The Pages and release workflows add comments about Electron's role and binary download.
The inspected workflows can skip the Electron download. The separate ESLint check failed for an unknown reason.
Pre-merge checks: 5
Check name
Status
Explanation
Title check
The title names the main change: setting ELECTRON_SKIP_BINARY_DOWNLOAD to skip Electron's binary download in the CI, release, and docs workflows. The raw summary confirms all three workflow files (ci.…
Description check
The description follows the repository template. It has a Summary section that states what changes and why, with the 504 failure context and the reason no job needs the binary. It includes Related (No…
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title names the main change: setting ELECTRON_SKIP_BINARY_DOWNLOAD to skip Electron's binary download in the CI, release, and docs workflows. The raw summary confirms all three workflow files (ci.yml, release.yml, pages-typedoc.yml) set this variable. The title uses the conventional commit prefix and is specific.
Full details: Description check
Explanation
The description follows the repository template. It has a Summary section that states what changes and why, with the 504 failure context and the reason no job needs the binary. It includes Related (No issue), Spec, plan and design (None), Pictures (No visible change), and a verification note. The Checklist section from the template is missing. The description also has a Type of change section and a Migration notes section that the template does not list. It does not mark the Tests added/updated or Docs updated items, and it does not state whether the Conventional commit title item is met. These gaps are minor for a CI-only change.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Reviewing files that changed from the base of the PR and between 946a93c and f710405.
Files selected for processing: 3
.github/workflows/ci.yml
.github/workflows/pages-typedoc.yml
.github/workflows/release.yml
Included review availability: This review used your included allowance. 0 included reviews remain after this review. Your included PR review attempts over the past 7 days set your current allowance at 1 review per hour.
Keep the workflow-level setting: it targets the unnecessary Electron download in every affected install without disabling other dependencies’ install scripts. A blanket script-skip option would be broader and risk breaking the build.
Files changed (3) +18 / -0
Other (3) +18 / -0
ci.ymlSkip Electron binary downloads across CI jobs+6/-0
Skip Electron binary downloads across CI jobs
• Sets ELECTRON_SKIP_BINARY_DOWNLOAD at workflow scope so dependency installs in CI do not rely on Electron’s binary host. A comment records the reason for the setting.
release.ymlSkip Electron binary downloads during releases+6/-0
Skip Electron binary downloads during releases
• Sets the variable at release workflow scope so the publish job’s dependency install does not depend on Electron’s binary download. The release workflow also calls the separately updated CI workflow.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The first daily release (run 42471100534, 8 November) failed before publishing 0.9.5, and its re-run failed the same way:
npm installruns Electron's install script, which downloads the Electron binary from GitHub's release servers, and those answered the runners with504 Gateway Time-outin the build, postgres18 and browser jobs.No job launches Electron. The package is a dev dependency for its types, and the tests that reach the Electron adapters mock the
electronmodule. This change setsELECTRON_SKIP_BINARY_DOWNLOAD=1at the top of ci.yml, release.yml and pages-typedoc.yml, so installs no longer depend on that download.Linked issues
No issue
Spec, plan and design
None
Pictures
No visible change
Type of change
How this was verified
This pull request runs the whole suite (build, postgres18, browser) with the variable set; a test that needed the binary would fail here. After the merge, a release dispatch publishes 0.9.5.
Migration notes
None
Summary by CodeRabbit