Skip to content

Consider a dedicated ci subcommand that bundles CI-appropriate defaults #12

@dacharyc

Description

@dacharyc

Context

After implementing --strict, --emit-annotations, and -o markdown, a typical CI workflow step for a published skill looks like:

skill-validator check --strict --emit-annotations my-skill/
skill-validator check --strict --emit-annotations -o markdown my-skill/ >> "$GITHUB_STEP_SUMMARY"

That's a lot of flags to get right consistently across multiple workflow jobs, and the two-step pattern (once for annotations, once for the summary) is awkward.

Proposed solution (tentative)

A ci subcommand that bundles sensible CI defaults:

  • --emit-annotations on by default
  • Appends markdown report to $GITHUB_STEP_SUMMARY automatically if that env var is set
  • --strict controlled by a --mode flag (published or in-progress) rather than requiring the caller to know which flag to pass
skill-validator ci --mode published my-skill/
skill-validator ci --mode in-progress my-skill/

Why this is tentative

This is a larger API surface decision. The underlying check command stays composable for local use and custom pipelines; ci would be an ergonomic shortcut for the 80% case. It's worth seeing how the annotation flag and strict flag feel in practice before committing to a dedicated subcommand.

Tracking here so the option isn't forgotten when the other CI enhancements are in place.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions