From d03a1a49462a1bf4f7cc4aa43161a2c3a895e7a7 Mon Sep 17 00:00:00 2001 From: Matti Airas Date: Tue, 3 Nov 2020 17:38:38 +0200 Subject: [PATCH] Describe the release process --- docs/RELEASE_PROCESS.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/RELEASE_PROCESS.md diff --git a/docs/RELEASE_PROCESS.md b/docs/RELEASE_PROCESS.md new file mode 100644 index 000000000..61755fe13 --- /dev/null +++ b/docs/RELEASE_PROCESS.md @@ -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. + + +