Skip to content

Add GitHub Actions workflow command reporter #459

@kehoecj

Description

@kehoecj

Description

Add a --reporter=github option that outputs validation errors as GitHub Actions workflow commands. This enables inline PR annotations without needing to use the separate validate configs action

Proposed behavior

validator --reporter=github .

Output format:

::error file=config/bad.json,line=3,col=12::syntax: unexpected token
::error file=deploy/broken.yaml,line=15,col=4::syntax: mapping values are not allowed here

Valid files produce no output (workflow commands are errors/warnings only).

Why

  • The validate-configs-action already provides PR annotations, but it requires using the GitHub Action wrapper
  • Many users run the validator CLI directly in their workflow steps — --reporter=github would give them annotations for free
  • Mimics how tools like golangci-lint, eslint, and shellcheck integrate with GitHub Actions

Metadata

Metadata

Assignees

No one assigned

    Labels

    CLIUpdate to the CLIgood first issueGood for newcomershas-prThis issue has an associated PRhelp wantedExtra attention is needednew reporter typeNew type of reporter to release

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions