Skip to content
ContractSpec
Start here

action.validation

GitHub Action for running ContractSpec CI checks

appsappv5.0.4stableservernode
@lssm-tech/action.validation
bun add @lssm-tech/action.validation
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

Website: https://contractspec.io

ContractSpec GitHub Action for CI/CD integration. Wraps the contractspec ci CLI command as a composite action.

What It Does

  • Layer: app (GitHub Action)
  • Consumers: external CI/CD pipelines via lssm/contractspec-action@v1

Usage

yaml
name: ContractSpec CI
on: pull_request
jobs:
  contractspec:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: read
    steps:
      - uses: actions/checkout@v6
      - uses: lssm-tech/contractspec/packages/apps/action-validation@main
        with:
          github-packages-token: ${{ secrets.CONTRACTSPEC_PACKAGES_TOKEN }}

For affected private GitHub Packages dependencies, github-packages-token must be a GitHub token that can read the ContractSpec packages granted to the consuming repository, bot, or GitHub App.

Inputs

  • checks (default: all) — Checks to run (comma-separated: structure,integrity,deps,doctor,handlers,tests) or "all"
  • skip — Checks to skip (comma-separated)
  • pattern — Glob pattern for spec discovery
  • fail-on-warnings (default: false) — Fail the action on warnings (not just errors)
  • check-handlers (default: false) — Include handler implementation checks
  • check-tests (default: false) — Include test coverage checks
  • upload-sarif (default: true) — Upload SARIF results to GitHub Code Scanning
  • working-directory (default: .) — Working directory for running checks
  • bun-version (default: latest) — Bun version to use
  • mode (default: validate) — Action mode: "validate" (run checks) or "impact" (detect breaking changes)
  • baseline — Git ref to compare against for impact detection (default: base branch from PR context)
  • pr-comment (default: true) — Post impact results as PR comment
  • github-token (default: ${{ github.token }}) — GitHub token for PR comments and check runs
  • github-packages-token — Optional token used to configure private GitHub Packages auth before dependency installs

Outputs

  • success — Whether all checks passed
  • errors — Number of errors found
  • warnings — Number of warnings found
  • sarif-file — Path to SARIF output file (if uploaded)
  • json-file — Path to JSON output file
  • impact-status — Impact status: "no-impact" | "non-breaking" | "breaking"
  • breaking-count — Number of breaking changes detected
  • non-breaking-count — Number of non-breaking changes detected

Key Files

  • action.yml — GitHub Action definition (composite action)
  • README.md — Usage documentation
  • package.json — Package metadata (private, not published to npm)

Local Commands

  • bun run test — bun test

Recent Updates

  • Replace eslint+prettier by biomejs to optimize speed
  • Stability
  • PublishConfig not supported by bun

Notes

  • All input/output changes must be reflected in both action.yml and README.md.
  • The action is versioned with tags on the repository — breaking input changes require a major version bump.
  • Test locally using act or by referencing the local action: uses: ./packages/apps/action-validation.

Relationships

THIS PACKAGEaction.validation1 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

1 declarations

Declared capabilities

This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.

Scripts

  • testbun test