arthurrump / esphome-opentherm

Create your own smart modulating thermostat using the OpenTherm component for ESPHome
BSD 2-Clause "Simplified" License
75 stars 42 forks source link

Add versioning with release notes #7

Closed arthurrump closed 2 years ago

arthurrump commented 2 years ago

It's not great if people depend on the main branch if there will be breaking changes. So we should set up a versioning scheme with tags for each version and some release notes (CHANGELOG.md). Each release has three tags: vX.Y.Z, vX.Y and vX. The latter two roll forward for each new patch release. This is how GitHub Actions are also typically versioned, e.g. actions/checkout has a v3.0.2 and a v3 tag, the latter of which formerly pointed to v3.0.1 and v3.0.0. Only vX.Y.Z tags are promoted to a release.