This document describes the process for releasing a new version of Electron.
The current process is to maintain a local file, keeping track of notable changes as pull requests are merged. For examples of how to format the notes, see previous releases on the releases page.
Create a new branch from
git checkout master git pull git checkout -b release
This branch is created as a precaution to prevent any merged PRs from sneaking into a release between the time the temporary release branch is created and the CI builds are complete.
bump-version script, passing
patch as an argument:
npm run bump-version -- patch git push origin HEAD
This will bump the version number in several files. See this bump commit for an example.
Most releases will be
patch level. Upgrades to Chrome or other major changes should use
minor. For more info, see electron-versioning.
Merge the temporary back into master, without creating a merge commit:
git merge release master --no-commit git push origin master
If this fails, rebase with master and rebuild:
git pull git checkout release git rebase master git push origin HEAD
Run local debug build to verify that you are actually building the version you want. Sometimes you thought you were doing a release for a new version, but you’re actually not.
npm run build npm start
Verify the window is displaying the current updated version.
You’ll need to set the following environment variables to publish a release. Ask another team member for these credentials.
ELECTRON_GITHUB_TOKEN- A personal access token with “repo” scope.
You will only need to do this once.
This script will download the binaries and generate the node headers and the .lib linker used on Windows by node-gyp to build native modules.
npm run release
Note: Many distributions of Python still ship with old HTTPS certificates. You may see a
InsecureRequestWarning, but it can be disregarded.
git checkout master git branch -D release # delete local branch git push origin :release # delete remote branch
© 2013–2017 GitHub Inc.
Licensed under the MIT license.