Skip to content

CI/CD Validation for JSON and YAML Files #42

@joshrotenberg

Description

@joshrotenberg

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.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions