[GitHub] [iceberg] kbendick opened a new issue #1300: Should we consider adding a github action to lint YAML files for correctness / proper style?

[GitBox <gi...@apache.org>]

kbendick opened a new issue #1300:
URL: https://github.com/apache/iceberg/issues/1300


   The project continues to add more and more .yaml / .yml files. I have been working on one myself for autolabeling PRs.
   
   It might be worth it to add a linter that will check that our YAML files are (1) syntactically correct and (2) meet our required style guide. Such examples of _possible_ style guides for YAML files would be to disallow trailing spaces, require that lists are indented by two spaces instead of continuing at the same indentation level as the key that starts them, etc.
   
   There are a few github actions that do this. I have experience with working with one of them and would be willing to take a crack at this if we think it's a good idea. It could be configured to only run before PRs are merged or on every push of the PR or under any other PR related scenario you can imagine.
   
   The reason I bring it up is that I recently was trying to test my own addition of a YAML configured autolabeler and had to merge it into my own fork multiple times, as I accidentally aded the ASF header to the file using java comment syntax and not YAML style syntax. Had we merged it, the YAML file would not have worked. Especially as many of our YAML files deal with automation that is critical but that people don't want to think about too much, I think this is worth considering.
   
   So... do we think that this would be a useful addition?


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org

[GitHub] [iceberg] kbendick commented on issue #1300: Should we consider adding a github action to lint YAML files for correctness / proper style?

[GitBox <gi...@apache.org>]

kbendick commented on issue #1300:
URL: https://github.com/apache/iceberg/issues/1300#issuecomment-701148058


   Given that our docs are developed from markdown in YAML files, I might go ahead and add this in.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org