Skip to content

Commit 540cedc

Browse files
committed
docs(contributing): add release process (#298)
1 parent 3e4cf4b commit 540cedc

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ npm start
5252
- `test` - run all tests
5353
- `build` - create a test build of the app for debugging purposes
5454
- `pkg` - package the production version of the app for release
55+
- `release` - create a new release
5556

5657
### Directory Structure
5758

@@ -71,6 +72,20 @@ These directories are **not** included in the packaged application.
7172
- `scripts` - miscellaneous scripts for development tasks
7273
- `test` - files for testing the application
7374

75+
### Release Process
76+
77+
1. Ensure all tests are passing.
78+
1. Create the new version section in `CHANGELOG.md`.
79+
1. Bump the version in `package.json`. Should match the version you just created in `CHANGELOG.md`.
80+
1. Run `npm run release`. This will create a github release draft.
81+
1. Travis-CI (for Linux and Mac) and Appveyor (for Windows) will start uploading builds to the release draft.
82+
1. Wait for uploads to finish. Check that everything worked during build by checking CI logs.
83+
1. Make sure tag format is `vX.X.X` (auto-update is picky about URL names).
84+
1. Publish the draft.
85+
1. Clients will automatically download the new version next time they start.
86+
87+
Our release process is based on [electron-builder](https://github.com/electron-userland/electron-builder)'s [Recommended GitHub Releases Workflow](https://github.com/electron-userland/electron-builder/blob/master/docs/configuration/publish.md#recommended-github-releases-workflow).
88+
7489
## Project Governance
7590

7691
**This is an [OPEN Open Source Project](http://openopensource.org/).**

0 commit comments

Comments
 (0)