Merge pull request #11154 from electron/update-release-doc

Update release process for API invoked release builds
This commit is contained in:
Cheng Zhao 2017-12-19 15:30:51 +09:00 committed by GitHub
commit 90582dfa4f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -4,8 +4,9 @@ This document describes the process for releasing a new version of Electron.
## Determine which branch to release from ## Determine which branch to release from
- **If releasing beta,** create a new branch from `master`. - **If releasing beta,** run the scripts below from `master`.
- **If releasing a stable version,** create a new branch from the beta branch you're stabilizing. - **If releasing a stable version,** run the scripts below from `1-7-x` or
`1-6-x`, depending on which version you are releasing for.
## Find out what version change is needed ## Find out what version change is needed
Run `npm run prepare-release -- --notesOnly` to view auto generated release Run `npm run prepare-release -- --notesOnly` to view auto generated release
@ -18,8 +19,10 @@ The prepare release script will do the following:
1. Check if a release is already in process and if so it will halt. 1. Check if a release is already in process and if so it will halt.
2. Create a release branch. 2. Create a release branch.
3. Bump the version number in several files. See [this bump commit] for an example. 3. Bump the version number in several files. See [this bump commit] for an example.
4. Create a draft release on GitHub with auto-generated release notes 4. Create a draft release on GitHub with auto-generated release notes.
5. Push the release branch so that the release builds get built. 5. Push the release branch.
6. Call the APIs to run the release builds.
Once you have determined which type of version change is needed, run the Once you have determined which type of version change is needed, run the
`prepare-release` script with arguments according to your need: `prepare-release` script with arguments according to your need:
- `[major|minor|patch|beta]` to increment one of the version numbers, or - `[major|minor|patch|beta]` to increment one of the version numbers, or
@ -49,13 +52,11 @@ npm run prepare-release -- --stable
``` ```
## Wait for builds :hourglass_flowing_sand: ## Wait for builds :hourglass_flowing_sand:
The `prepare-release` script will trigger the builds via API calls.
The presence of the word [`Bump`](https://github.com/electron/electron/blob/7961a97d7ddbed657c6c867cc8426e02c236c077/script/cibuild-linux#L3-L6) in the commit message created by the `bump-version` script
will [trigger the release process](https://github.com/electron/electron/blob/7961a97d7ddbed657c6c867cc8426e02c236c077/script/cibuild#L82-L96).
To monitor the build progress, see the following pages: To monitor the build progress, see the following pages:
- [208.52.191.140:8080/view/All/builds](http://208.52.191.140:8080/view/All/builds) for Mac - [mac-ci.electronjs.org/blue/organizations/jenkins/electron-mas-x64-release/activity](https://mac-ci.electronjs.org/blue/organizations/jenkins/electron-mas-x64-release/activity) for Mac App Store
- [mac-ci.electronjs.org/blue/organizations/jenkins/electron-osx-x64-release/activity](https://mac-ci.electronjs.org/blue/organizations/jenkins/electron-osx-x64-release/activity) for OS X
- [circleci.com/gh/electron](https://circleci.com/gh/electron) for Linux - [circleci.com/gh/electron](https://circleci.com/gh/electron) for Linux
- [windows-ci.electronjs.org/project/AppVeyor/electron](https://windows-ci.electronjs.org/project/AppVeyor/electron) for Windows - [windows-ci.electronjs.org/project/AppVeyor/electron](https://windows-ci.electronjs.org/project/AppVeyor/electron) for Windows