search

Azure / k8s-bake

GitHub Action creating Kubernetes manifest files with Helm, Kustomize, or Kompose
MIT License
52 stars 33 forks source link

Feature Request: Detect accidental usage of `=` as key-value separator in overrides #97

Open pnevyk opened 7 months ago

pnevyk commented 7 months ago

Feature request

In the Helm example, it is clear that the separator for key and value is :, for example replicas:2. However, I think it's easy to accidentally use = as the separator like replicas=2, perhaps because some other GH actions use it (e.g., docker/build-push-action using it for build-args and secrets) or it's used in shells for variables. (Note: our team actually made this typo and it even slipped through the review.)

Would it be in scope of the action to check for this mistake? In the current implementation, I believe that if replicas=2 are given, then the overrideName would be replicas=2 and overrideValue would be empty. Is there a use case for an empty value? If an empty value is detected and a single = character found in overrideName, would it make sense to fail with an error or at least give a warning?

Alternatively, would it be possible to support = as a valid key-value separator? (Personally, I don't think this is the right way.)

Feel free to close this issue with "not in scope" or "there are reasons why this wouldn't work/would be too tricky".

jatin-mehrotra-colorkrew commented 1 month ago

I am also facing the same issue.