agones icon indicating copy to clipboard operation
agones copied to clipboard

Make indentation for sequences consistent in helm templates

Open pjayara-g opened this issue 3 years ago • 1 comments

Is your feature request related to a problem? Please describe. Some templates put spaces before the '-' while others don't. The yaml spec itself says that either is ok. Since it is inconsistent, it causes issues for yaml linters. With space: https://github.com/googleforgames/agones/blob/main/install/helm/agones/templates/crds/fleet.yaml#L37 Without space: https://github.com/googleforgames/agones/blob/main/install/helm/agones/templates/controller.yaml#L79

Describe the solution you'd like Be consistent about whether or not to put spaces before '-'. Perhaps add a yamllinter (like https://github.com/adrienverge/yamllint) to ensure that this is the case.

Describe alternatives you've considered I did not consider alternatives.

Additional context None

pjayara-g avatar Jan 20 '22 23:01 pjayara-g

Adding a linter to our CI checks would be great, since it'll both fix any inconsistencies and also prevent them from recurring in the future.

We could either try to lint all of our helm files individually, or we could run the linter on install.yaml after it is generated.

roberthbailey avatar Jan 20 '22 23:01 roberthbailey

as #3358 merged. maybe it's ok to close this?

Bogay avatar Oct 04 '23 09:10 Bogay