Skip to content

Commit 15a09b2

Browse files
committed
add explanation of release steps
1 parent 538cf7b commit 15a09b2

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,37 @@ And, launch electron on development:
107107
$ npm start
108108
```
109109

110+
## Releasing Editor
111+
112+
This steps are for releasing a new version of Editor.
113+
114+
### 1. Update to the new version
115+
116+
The following two files need to be updated.
117+
118+
- app/editor/version.js
119+
- app/package.json
120+
121+
### 2. Update documents
122+
123+
- CHANGELOG.md (required)
124+
- README.md (if needed)
125+
126+
### 3. Push them to `build/release-x.x.x` branch and test the built packages for each platform
127+
128+
Pushing to `build/*` branch runs a job to build the package. Make sure that the built packages for each platform work properly. You can download the packages from the artifact of the build. For more information, see [Build workflow](.github/workflows/build.yml).
129+
130+
### 4. Create pullrequest
131+
132+
If there is no problem, create a pullrequest.
133+
134+
### 5. Merge pullrequest and push tag
135+
136+
Pushing a tag runs a job to build and release package. Check the followings:
137+
138+
- Correct version and content of the release
139+
- All package files are attached to the release
140+
110141
## License
111142

112143
Thinreports Editor is licensed under the [GPLv3](https://github.com/thinreports/thinreports-editor/blob/master/GPLv3).

0 commit comments

Comments
 (0)