From 9abcc1f4138c3acd703862e2ee1f75b0b63cc796 Mon Sep 17 00:00:00 2001 From: Yusuke Kuoka Date: Wed, 8 Jun 2022 01:55:10 +0000 Subject: [PATCH] proposal: Drop --arsg in Helmfile 1.0 Signed-off-by: Yusuke Kuoka --- docs/proposals/towards-1.0.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/proposals/towards-1.0.md b/docs/proposals/towards-1.0.md index 2ea29577..31161abb 100644 --- a/docs/proposals/towards-1.0.md +++ b/docs/proposals/towards-1.0.md @@ -1,6 +1,8 @@ # Towards Helmfile 1.0 -I'd like to make two backward-incompatible changes to Helmfile and mark it as 1.0, so that we can better communicate with the current and future Helmfile users about our stance on maintaining Helmfile. +I'd like to make 3 breaking changes to Helmfile and mark it as 1.0, so that we can better communicate with the current and future Helmfile users about our stance on maintaining Helmfile. + +Note that every breaking change should have an easy alternative way to achieve the same goal achieved using the removed functionality. ## The changes in 1.0 @@ -56,6 +58,11 @@ I'd like to make two backward-incompatible changes to Helmfile and mark it as 1. - As the primary maintainer of the project, I'm tired of explaining why Helmfile renders go template expressions embedded in a yaml comment. [The latest example of it](https://github.com/helmfile/helmfile/issues/127). - When we first introduced helmfile the ability to render helmfile.yaml as a go template, I did propose it to require `.gotmpl` file extension to enable the feature. But none of active helmfile users and contributors at that time agreed with it (although I didn't have a very strong opinion on the matter either), so we enabled it without the extension. I consider it as a tech debt now. +3. Remove the `--args` flag from the `helmfile` command + - It has been provided as-is, and never intended to work reliably because it's fundamentally flawed because we have no way to specify which args to be passed to which `helm` commands being called by which `helmfile` command. + - However, I periodically see a new user finds it's not working and reporting it as a bug([the most recent example](https://github.com/roboll/helmfile/issues/2034#issuecomment-1147059088)). It's not a fault of the user, but out fault that left this broken feature. + - Every use-case previsouly covered (by any chance) with `--args` should be covered in new `helmfile.yaml` fields or flags. + ## After 1.0 We won't add any backward-incompatible changes while in 1.x, as long as it's inevitable to fix unseen important bug(s).