@lssm-tech/app.action-prapp.action-pr
GitHub Action for ContractSpec PR checks
@lssm-tech/app.action-prSource, release and verification context
Source snapshot bcc79fcc · Declared package version 4.0.4. This page combines the checked-in package guide and manifest; commands and runtime behavior were not executed in this review.
servernode
See where this package fits.
Follow a declared connection, inspect an import, then open the source guide when you need the detail.
THIS PACKAGEapp.action-prapps
Arrows point from a package to its direct dependency. Each count is derived from the captured manifests.
PACKAGE GUIDERead at source ↗
@lssm-tech/action.pr
Website: https://contractspec.io
GitHub Action that runs ContractSpec validation checks on pull requests. Posts drift reports, validation results, and product views as PR comments.
What It Does
- Uses
@lssm-tech/lib.contracts-specfor contract definitions - Uses
@lssm-tech/bundle.workspacefor workspace analysis - Configured via
action.yml; nosrc/— logic lives in workspace bundle
Usage
name: ContractSpec PR
on: pull_request
jobs:
contractspec:
runs-on: ubuntu-latest
permissions:
contents: read
packages: read
pull-requests: write
steps:
- uses: actions/checkout@v6
- uses: lssm-tech/contractspec/packages/apps/action-pr@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 commandsreport-mode(default:summary) — Report output mode (summary|comment|both|off)enable-drift(default:true) — Run drift detection after generatefail-on(default:any) — Fail on breaking, drift, any, or nevergenerate-command(default:bun contractspec generate) — Command to regenerate artifacts (required when enable-drift=true)validate-command— Override validation commandcontracts-dir— Directory containing contract specscontracts-glob— Glob pattern for contract specstoken(default:${{ github.token }}) — GitHub token for PR commentsgithub-packages-token— Optional token used to configure private GitHub Packages auth before dependency installs
Outputs
drift-detected— Whether drift was detectedbreaking-change-detected— Whether breaking changes were detectedvalidation-failed— Whether validation failed
Key Files
action.yml— GitHub Action definitionfixtures/— Test report data and validation fixtures.contractspec-ci/contracts.json— CI contract configuration
Local Commands
bun run test— bun test
Recent Updates
- Replace eslint+prettier by biomejs to optimize speed
- Stability
- Standardize tool naming to underscore notation
Notes
- Do not change
action.ymlinputs/outputs without updating downstream workflow consumers - Fixture files are used for CI testing — keep them valid
Declared capabilities.
This manifest does not declare a capability catalogue. Use the guide, import map and source to assess the package.
Imports and export paths.
1 entriesThese are package-manifest entry points. Named symbols listed above come from the capability catalogue; this is not an exhaustive TypeScript symbol reference.
1 import
No export paths match this search.
Dependencies and related packages.
Runtime dependencies 2
- @lssm-tech/bundle.workspace
- workspace:^
- @lssm-tech/lib.contracts-spec
- workspace:^
Development dependencies 4
- @lssm-tech/tool.typescript
- workspace:*
- @types/bun
- catalog:types
- @types/node
- catalog:types
- typescript
- catalog:
Package scripts.
Commands declared by this package. Review its setup requirements before running them; no command here was executed by this review.
test
bun test