Skip to content

Commit

Permalink
Describe the release process
Browse files Browse the repository at this point in the history
  • Loading branch information
mairas committed Nov 3, 2020
1 parent d9fe9e7 commit d03a1a4
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/RELEASE_PROCESS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# SensESP release process

1. Create a new `release` branch (or rebase an existing one)

2. Update autogenerated html and js source files:

pio run -e d1_mini -t webUI

Remember to commit the results.

3. Update the doxygen docs (first bump the version number in `Doxyfile`)

doxygen

Again, commit the results.

4. Push the changes to `upstream` `release` branch. This is the release branch
from which the actual release is made.

5. Verify that everything looks OK in the SignalK/SensESP `release` branch.

6. Create (or rebase) a new local `latest` branch. Push that to
`upstream` `latest`.

7. Navigate to https://github.com/SignalK/SensESP/releases and click on
"Draft a new release". Tag version is "x.y.z". Be sure to select `latest`
branch. Title is ordinarily "Version x.y.z". Description would ideally
be a listing of new features and bugfixes.

8. The release is now done. Finally, create a PR from `latest` to `master`
and merge it. This will bring `master` up to date with the released version.



0 comments on commit d03a1a4

Please sign in to comment.