GoogleCloudPlatform / prometheus-test-infra

Apache License 2.0
11 stars 3 forks source link

Adding a GitHub Action for linting YAML files during PRs #16

Open saketjajoo opened 1 year ago

saketjajoo commented 1 year ago

It would be nice to have a GitHub Action that lints all the prombench-related YAML files whenever a PR is created (or updated). This would highlight the code readability issues and suggest solutions to fix those.

yamllint is a tool that can be used to lint yaml files and it comes pre-installed on all the ubuntu-based GitHub runners. It also supports customization for rules so that some of them can be disabled (or changed as per needs) so that some "not-so-important" lint errors can be suppressed.

Example Commit: https://github.com/GoogleCloudPlatform/prometheus-test-infra/commit/74bcfba67a8edafe0581d0516221f75691630fb6