Streamline the release process
The latest branch is no longer used
@@ -5,9 +5,7 @@ simplifications. Main differences are:
- Since releasing is a rapid process, long-lived release branches are not
needed. Releases can be made directly from feature branches.
-- `master` (or `main` in the future) is the unstable development branch.
-- `latest` is the last released version. Releases must be tagged from
- this branch.
+- `main` is the unstable development branch.
The release process has a lot of prerequisites, some of which are mentioned below:
@@ -41,13 +39,12 @@ The release process is as follows:
Any release testing should happen now at this point.
-6. Once everything is fine, create a PR against the `latest` branch.
+6. Once everything is fine, create a PR against the `main` branch.
Merge it.
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
+ "Draft a new release". Tag version is "x.y.z". Title is ordinarily "Version x.y.z". Description would ideally
be a listing of new features and bugfixes.
7. Notify PlatformIO about the new release. This command may create a new
@@ -60,12 +57,11 @@ The release process is as follows:
You need suitable permissions to run the `pio package publish` command. If
you don't have them, ask Matti Airas <mairas@iki.fi> for assistance.
-8. All that remains is to update the master branch. Create a new `release_x.y.z_to_master` branch based
- on `latest`. Run
+8. All that remains is to update the main branch version number to `x.y.z+1-alpha`. Create a new `post_release_x.y.z`. Run
bumpversion release
to bump the version to `x.y.z+1-alpha`.
Push the new branch to your own fork,
- create a PR against `master`, and merge it.
+ create a PR against `main`, and merge it.
