GitHub Action Reference

The Stoney GitHub Action accepts the following inputs.

Core Inputs

base_url

Base URL for HTTP checks.

Required for HTTP steps.

suite

Glob or file path for contract files.

Default:

contracts/*.yml

token

Optional bearer token available to contracts via ${STONEY_TOKEN}.

Execution Controls

timeout_ms

Request timeout in milliseconds.

Default:

15000

retries

Retry count for HTTP requests.

Default:

2

fail_fast

Stop on the first failing check.

Default:

false

When enabled, Stoney stops after the first failing check (including policy failures like missing work_item when required).

Reporting Controls

report

Path to write JSON report.

Default:

stoney-report.json

upload_artifact

Whether to upload report artifact.

Default:

true

artifact_name

Artifact name.

Default:

stoney-report

comment_pr

Post summary comment on PRs.

Default:

true

Requirements Enforcement

require_work_item

Fail if any check is missing work_item.

Default:

false

work_item_pattern

Optional regex that work_item must match (e.g. ^KAN-\d+$).

Database

db_url

Postgres connection string.

Passed to STONEY_DB_URL for SQL checks.

Example

- uses: stoney-dev/stoney@v0
  with:
    base_url: ${{ secrets.STONEY_BASE_URL }}
    suite: "contracts/*.yml"
    token: ${{ secrets.STONEY_TOKEN }}
    retries: "2"
    timeout_ms: "15000"
 
    # stop after first failure
    fail_fast: "true"
 
    # policy controls
    require_work_item: "true"
    work_item_pattern: "^KAN-\\d+$"