diff --git a/doc/release_plan.md b/doc/release_plan.md new file mode 100644 index 0000000..c0c73de --- /dev/null +++ b/doc/release_plan.md @@ -0,0 +1,15 @@ +# Release plan + +All development is done in the `dev` branch. Once the development branch is +ready for a new production release, the following steps are followed:. + +- branch `Year.Month.Version-release` from `dev`. + + +Before release, check if the minimum version requirement for ESPHome is documented +correctly in the following files: + + * doc/installation.md + * README.md + * CHANGELOG.md + diff --git a/doc/testplan.md b/doc/test_plan.md similarity index 94% rename from doc/testplan.md rename to doc/test_plan.md index 0274e69..3df5e7d 100644 --- a/doc/testplan.md +++ b/doc/test_plan.md @@ -1,4 +1,4 @@ -# Testplan +# Test plan This is the test plan that I follow for every release. I use it to ensure that no regression has been introduced. @@ -70,11 +70,4 @@ been introduced. ## Step 3: Release the new version Only after performing these tests successfully, the new version can be released. - -Before release, check if the minimum version requirement for ESPHome is documented -correctly in the following files: - - * doc/installation.md - * README.md - * CHANGELOG.md - +Release steps are documented in [`releaseplan.md`](releaseplan.md).