app.action-drift

@lssm-tech/action.drift

Website: https://contractspec.io

GitHub Action that detects contract drift between specs and implementation. Runs in CI to flag when generated code diverges from its source contracts.

What It Does

• Uses @lssm-tech/lib.contracts-spec for contract definitions
• Uses @lssm-tech/bundle.workspace for workspace analysis
• Configured via action.yml; no src/ — logic lives in workspace bundle

Usage

name: ContractSpec Drift
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-drift@main
        with:
          github-packages-token: ${{ secrets.CONTRACTSPEC_PACKAGES_TOKEN }}
          generate-command: 'bun contractspec generate'

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

• package-manager (default: bun) — Package manager to use (bun|npm|pnpm|yarn)
• working-directory (default: .) — Working directory for running commands
• generate-command (default: bun contractspec generate) — Command to regenerate artifacts
• on-drift (default: fail) — Behavior when drift is detected (fail|issue|pr)
• drift-paths-allowlist — Comma-separated glob patterns to check for drift
• token (default: ${{ github.token }}) — GitHub token for issues/PRs
• github-packages-token — Optional token used to configure private GitHub Packages auth before dependency installs

Outputs

• drift-detected — Whether drift was detected

Key Files

• action.yml — GitHub Action definition
• fixtures/ — Test report data for drift scenarios

Local Commands

• bun run test — bun test

Recent Updates

• Replace eslint+prettier by biomejs to optimize speed
• Stability
• Stability improvements

Notes

• Do not change action.yml inputs/outputs without updating downstream workflow consumers
• Fixture JSON files are used for CI testing — keep them valid