diff --git a/README.md b/README.md index 85b62c3a..4b5e685b 100644 --- a/README.md +++ b/README.md @@ -46,15 +46,10 @@ To avoid upgrades for each iteration of `helm`, the `helmfile` executable delega ## Status +May 2024 Update - We are inviting Helmfile v1 rc testers! Please see the v1 proposal [here](docs/proposals/towards-1.0.md) and the latest rc release in the [releases](/release) page. Please file feature requests in [Discussions](/discussions) and bugs in [Issues](/issues). + March 2022 Update - The helmfile project has been moved to [helmfile/helmfile](https://github.com/helmfile/helmfile) from the former home `roboll/helmfile`. Please see roboll/helmfile#1824 for more information. -Even though Helmfile is used in production environments [across multiple organizations](USERS.md), it is still in its early stage of development, hence versioned 0.x. - -Helmfile complies to Semantic Versioning 2.0.0 in which v0.x means that there could be backward-incompatible changes for every release. - -Note that we will try our best to document any backward incompatibility. And in reality, helmfile had no breaking change for a year or so. - - ## Installation **1: Binary Installation** diff --git a/docs/proposals/towards-1.0.md b/docs/proposals/towards-1.0.md index 29e3b6bd..31009f88 100644 --- a/docs/proposals/towards-1.0.md +++ b/docs/proposals/towards-1.0.md @@ -4,6 +4,22 @@ I'd like to make 3 breaking changes to Helmfile and mark it as 1.0, so that we c Note that every breaking change should have an easy alternative way to achieve the same goal achieved using the removed functionality. +## Backward compatibility + +v1 is backward-compatible with v0.x, except for the following breaking changes. + +Each breaking change has an easy alternative way to achieve the same goal achieved using the removed functionality. + +We also provide the alternative way in the latest v0.x release before v1.0. That way you can start using the alternative way today and be ready for v1.0. Note that in v0.x, some of those alternative ways are enabled only when `HELMFILE_V1MODE=true` is set. + +> Context: +> +> Even though Helmfile had been used in production environments [across multiple organizations](USERS.md), it had been considered to be in its early stage of development, hence versioned 0.x. +> +> Helmfile complies to Semantic Versioning 2.0.0 in which v0.x means that there could be backward-incompatible changes for every release. However, Helmfile has been very conservative about breaking changes, and we had no breaking change for a year or so before start thinking about v1. +> +> That said, you can expect Helmfile v1 to be backward-compatible as much as it was in v0.x. + ## The changes in 1.0 1. [Forbid the use of `environments` and `releases` within a single helmfile.yaml.gotmpl part](#forbid-the-use-of-environments-and-releases-within-a-single-helmfileyamlgotmpl-part)