{"id":13406362,"url":"https://github.com/electron/update-electron-app","last_synced_at":"2026-05-01T23:02:48.173Z","repository":{"id":31877198,"uuid":"129999554","full_name":"electron/update-electron-app","owner":"electron","description":"🌲 A drop-in module that adds autoUpdating capabilities to Electron apps","archived":false,"fork":false,"pushed_at":"2026-04-20T20:12:39.000Z","size":2027,"stargazers_count":820,"open_issues_count":27,"forks_count":143,"subscribers_count":66,"default_branch":"main","last_synced_at":"2026-04-25T13:03:16.460Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/electron.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-04-18T03:37:36.000Z","updated_at":"2026-04-20T09:29:59.000Z","dependencies_parsed_at":"2023-02-18T11:04:45.788Z","dependency_job_id":"f98a1705-da43-4e8a-8ed5-9c3b2233285f","html_url":"https://github.com/electron/update-electron-app","commit_stats":{"total_commits":92,"total_committers":16,"mean_commits":5.75,"dds":0.7608695652173914,"last_synced_commit":"cded00e358398be739f2072bc9580fff18b2c828"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/electron/update-electron-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Fupdate-electron-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Fupdate-electron-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Fupdate-electron-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Fupdate-electron-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/electron","download_url":"https://codeload.github.com/electron/update-electron-app/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/electron%2Fupdate-electron-app/sbom","scorecard":{"id":372018,"data":{"date":"2025-08-11","repo":{"name":"github.com/electron/update-electron-app","commit":"a4ac7ddab543a3266e597363d2b73cc838536bd4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.3,"checks":[{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":1,"reason":"0 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":10,"reason":"all changesets reviewed","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'statuses' permission set to 'write': .github/workflows/semantic.yml:17","Info: jobLevel 'pull-requests' permission set to 'read': .github/workflows/semantic.yml:16","Info: found token with 'none' permissions: .github/workflows/add-to-project.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: topLevel 'contents' permission set to 'read': .github/workflows/semantic.yml:11","Info: topLevel 'contents' permission set to 'read': .github/workflows/test.yml:12"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":10,"reason":"all dependencies are pinned","details":["Info:   4 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   4 out of   4 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-xffm-g5w8-qvg7","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-18T13:11:48.025Z","repository_id":31877198,"created_at":"2025-08-18T13:11:48.025Z","updated_at":"2025-08-18T13:11:48.025Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32515838,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T19:02:28.127Z","updated_at":"2026-05-01T23:02:48.164Z","avatar_url":"https://github.com/electron.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","JavaScript"],"sub_categories":[],"readme":"# update-electron-app\n\n\u003e A drop-in module that adds autoUpdating capabilities to Electron apps\n\n[![Test](https://github.com/electron/update-electron-app/actions/workflows/test.yml/badge.svg)](https://github.com/electron/update-electron-app/actions/workflows/test.yml)\n[![npm version](http://img.shields.io/npm/v/update-electron-app.svg)](https://npmjs.org/package/update-electron-app)\n\nSupports multiple update sources:\n* The free and open-source [update.electronjs.org](https://update.electronjs.org) service.\n* Static file storage E.g. S3, Google Cloud Storage, etc.\n\n![screenshot](screenshot.png)\n\n## Requirements\n\nBefore using this module, make sure your Electron app meets these criteria:\n\n- Your app runs on macOS or Windows\n- Your builds are [code signed] **(macOS only)**\n- **If** using `update.electronjs.org`\n  - Your app has a public GitHub repository\n  - Your builds are published to GitHub Releases\n- **If** using static file storage\n  - Your builds are published to S3 or other similar static file host using a tool like `@electron-forge/publisher-s3`\n\n## Installation\n\n```sh\nnpm i update-electron-app\n```\n\n## Usage\n\n### With `update.electronjs.org`\n\nDrop this anywhere in your main process:\n\n```js\nconst { updateElectronApp } = require('update-electron-app')\nupdateElectronApp()\n```\n\nBy default your repository URL is found in [your app's `package.json` file](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#repository).\n\nYou can also specify custom options:\n\n```js\nconst { updateElectronApp, UpdateSourceType } = require('update-electron-app')\nupdateElectronApp({\n  updateSource: {\n    type: UpdateSourceType.ElectronPublicUpdateService,\n    repo: 'github-user/repo'\n  },\n  updateInterval: '1 hour',\n  logger: require('electron-log')\n})\n```\n\n### With static file storage\n\n```js\nconst { updateElectronApp, UpdateSourceType } = require('update-electron-app')\nupdateElectronApp({\n  updateSource: {\n    type: UpdateSourceType.StaticStorage,\n    baseUrl: `https://my-bucket.s3.amazonaws.com/my-app-updates/${process.platform}/${process.arch}`\n  }\n})\n```\n\n## What happens?\n\nOnce you've called `updateElectronApp` as documented above, that's it! Here's what happens by default:\n\n- Your app will check for updates at startup, then every ten minutes. This interval is [configurable](#API).\n- No need to wait for your app's `ready` event; the module figures that out.\n- If an update is found, it will automatically be downloaded in the background.\n- When an update is finished downloading, a dialog is displayed allowing the user to restart the app now or later.\n\n## API\n\n### `update(options)`\n\nAdditional Options:\n\n- `updateInterval` String (optional) - How frequently to check for updates. Defaults to `10 minutes`. Minimum allowed interval is `5 minutes`. This is a human readable interval supported by the [`ms`](https://github.com/vercel/ms#readme) module\n- `logger` Object (optional) - A custom logger object that defines a `log` function. Defaults to `console`. See [electron-log](https://github.com/megahertz/electron-log), a module that aggregates logs from main and renderer processes into a single file.\n- `notifyUser` Boolean (optional) - Defaults to `true`.  When enabled the user will be\n  prompted to apply the update immediately after download.\n\n## FAQ\n\n### What kinds of assets do I need to build?\n\nFor macOS, you'll need to build a `.zip` file.\nUse [electron-forge] or [electron-installer-zip] to package your app as a zip.\n\nFor Windows, you'll need to build a `.exe` and `.nupkg` files with [electron-forge] or [electron-winstaller].\n\n### Why is my app launching multiple times?\n\nWindows apps have an update process that requires multiple application restarts.\nYou can use the [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) module to improve this\nbehavior.\n\n### Can I use this module by uploading my private app's builds to a public GitHub repository?\n\nYes :)\n\n### I want to manually upload my builds to a static storage solution, where do I put them?\n\nIf you publish your builds manually ensure the file structure is:\n* `**/{platform}/{arch}/{artifact}`\n\nFor example that means that these files should exist:\n* `**/win32/x64/RELEASES`\n* `**/darwin/arm64/RELEASES.json`\n* `**/darwin/arm64/My App v1.0.0.zip` (or something similar)\n* ...\n\n### How does this module handle GitHub release states?\n\nIf using the public update service, the https://update.electronjs.org server handles release fetching logic.\nOnly releases that have valid SemVer tags and are _not_ marked as draft or pre-release will be collected by\nthe update service.\n\nThe latest release returned by the [`repos/{owner}/{repo}/releases`](https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#list-releases)\nGitHub API containing all requisite binaries will be the update target.\n\n## License\n\nMIT\n\n[electron-forge]: https://github.com/electron/forge\n[electron-installer-zip]: https://github.com/electron-userland/electron-installer-zip\n[electron-winstaller]: https://github.com/electron/windows-installer\n[code signed]: https://www.electronjs.org/docs/latest/tutorial/code-signing\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Fupdate-electron-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Felectron%2Fupdate-electron-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Felectron%2Fupdate-electron-app/lists"}