Skip to content

CI/CD Validation for JSON and YAML Files #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
5 tasks
joshrotenberg opened this issue Apr 28, 2025 · 0 comments
Open
5 tasks

CI/CD Validation for JSON and YAML Files #42

joshrotenberg opened this issue Apr 28, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@joshrotenberg
Copy link

Overview

This sub-issue proposes setting up lightweight CI checks to validate JSON and YAML files to catch simple errors early.

The goal is to add basic format validation with minimal friction during development.

Tasks

  • Add GitHub Action to validate all .json files (dashboards, etc.)
    • Use a simple tool like jq or jsonlint
  • Add GitHub Action to validate all .yml and .yaml files (prometheus rules, configurations)
    • Use a tool like yamllint
  • Configure the workflows to run automatically on:
    • Pull requests
    • Pushes to main
  • Fail CI if invalid files are detected
  • Keep workflows lightweight and fast (<1 min typical run time)

Notes

  • Focus initially on basic format validation only (syntax correctness).
  • Deeper semantic validation (e.g., validating Grafana dashboards or Prometheus rules more fully) can be added later.
  • No changes required to the main repo content — just adds workflows.
@joshrotenberg joshrotenberg added the enhancement New feature or request label Apr 28, 2025
@joshrotenberg joshrotenberg self-assigned this Apr 28, 2025
@joshrotenberg joshrotenberg changed the title dd CI/CD Validation for JSON and YAML Files CI/CD Validation for JSON and YAML Files Apr 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant