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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,6 +52,7 @@ npm start
52
52
-`test` - run all tests
53
53
-`build` - create a test build of the app for debugging purposes
54
54
-`pkg` - package the production version of the app for release
55
+
-`release` - create a new release
55
56
56
57
### Directory Structure
57
58
@@ -71,6 +72,20 @@ These directories are **not** included in the packaged application.
71
72
-`scripts` - miscellaneous scripts for development tasks
72
73
-`test` - files for testing the application
73
74
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
+
74
89
## Project Governance
75
90
76
91
**This is an [OPEN Open Source Project](http://openopensource.org/).**
0 commit comments