GitHub Actions quickstart

Run Abizor on one pull request in CI.

Add one GitHub Actions workflow, open a pull request, and let Abizor check whether the AI change is still supported before merge. The output tells the team what happened, where it stopped, and what to do next.

The whole first run is three steps: add one workflow, open a pull request, and read the run record. The public action naming target is Abizor/abizor-check-action@v1, backed by a verified target run record for the current public package.

Input existing pull request

Runs in your GitHub Actions runner

Run record Abizor event log

Delivery boundary no create, no merge

Copy this workflow

The first verified run is one minimal GitHub Actions workflow.

Add this file, open a same-repository pull request, and read the Actions summary, Abizor Check, and evidence bundle.

name: Abizor PR Check

on:
  pull_request:

permissions:
  contents: read
  pull-requests: read
  checks: write

jobs:
  abizor-pr-check:
    runs-on: ubuntu-latest
    steps:
      - name: Run Abizor PR check
        id: abizor
        uses: Abizor/abizor-check-action@v1
        with:
          verification-command: python3 -m unittest discover
          github-token: ${{ github.token }}

What this verifies

A self-serve verified run for one PR.

This is the shortest current path to see Abizor work without a hosted app. It runs the versioned GitHub Actions action, reads the existing PR diff, runs your configured verification command, reads GitHub check state, and writes a run record.

It does not create the PR, merge the PR, deploy code, use a GitHub App, or send your repository through a hosted Abizor runtime. The hosted GitHub App path is a future surface over the same kernel, not the current quickstart.

What the workflow checks

Abizor checks whether the AI PR is supported before merge.

PR diff

Reads the current branch against the base ref instead of relying on chat memory.

Verification receipt

Runs the command you choose in your GitHub Actions runner and records the result.

Check state

Reads the existing PR checks before readiness, without creating or merging anything.

Reviewable output

Uploads a run record, summary, PR comment body, and artifact manifest.

Workflow shape

The core step is one versioned action.

The action owns checkout, base-ref fetch, Python setup, PyPI installation, run generation, record verification, Check publishing, and artifact upload.

- name: Run Abizor PR check
  id: abizor
  uses: Abizor/abizor-check-action@v1
  with:
    verification-command: python3 -m unittest discover
    github-token: ${{ github.token }}

Set verification-command to the command your repository already trusts: python3 -m unittest discover, npm test, go test ./..., cargo test, or ./gradlew test. Abizor runs it in your runner and records the result as a receipt.

Required PR shape

The action uses a named PR head branch.

Abizor needs a branch identity so it can adopt the existing pull request instead of guessing. The action checks out the PR head branch, fetches the base ref explicitly, and rejects detached checkout state with a clear error.

Pull requests opened from forks run with a read-only GITHUB_TOKEN, so GitHub blocks the Check publish step there. The current verified-run path is intended for same-repository branches; fork pull request support is not self-serve yet.

GitHub Actions action

Target the v1 GitHub Actions action rename.

The public GitHub Actions action naming target is Abizor/abizor-check-action@v1. The direct PyPI/static wheel release is verified for abizor==0.1.8. The renamed GitHub Actions action @v1 default has a verified target run record after the public action repository rename.

uses: Abizor/abizor-check-action@v1

The current public package can be installed directly with python3 -m pip install abizor==0.1.8. This is not a hosted app, a hosted API, a GitHub App install, or a billing flow.

Action repository: https://github.com/Abizor/abizor-check-action

Secondary verified wheel: https://abizor.dev/downloads/abizor-0.1.8-py3-none-any.whl

Current PyPI/static wheel SHA-256: efbaef70e75636f66101a65238d6392afa02a027e26869a6744f278e6f662e8e

Release evidence is maintained in the repository.

View the action repository

What you get after the first run

Four outputs reviewers can inspect.

GitHub Check

A PR-visible projection of the current run result.

Actions summary

A readable CI summary with status and evidence links.

evidence bundle

The event log, manifest, run artifacts, and generated records.

Change Record

Readable JSON and Markdown records for the run.

Mini-glossary

The first run has four names worth knowing.

Event logdurable run record

Change Recordreadable JSON/Markdown record

GitHub CheckPR-visible projection

verify-recordlocal verifier

CLI boundary

Start with the compatibility commands.

Public quickstartabizor pr-check and abizor verify-record.

Optional advancedabizor feedback-export, abizor post-comment, abizor publish-check, and abizor run-next.

Delivery boundaryThe quickstart does not merge and does not run in hosted Abizor infrastructure. Guarded delivery requires an explicit operator path such as abizor run-next --allow-merge.

Feedback export

Generate a local redacted feedback file when you want help.

The feedback export is optional. It is a local Markdown projection with whitelisted status values and short questions for the Abizor team. It is not uploaded automatically.

abizor feedback-export \
  --event-log "$RUNNER_TEMP/abizor-events.json" \
  --manifest "$RUNNER_TEMP/abizor-artifacts.json" \
  --change-record-json "$RUNNER_TEMP/abizor-change-record.json" \
  --output "$RUNNER_TEMP/abizor-feedback.md"

The generated file asks what failed, what was unclear, what felt unsafe, and what would block CI adoption. It excludes repository content, pull request data, diffs, file paths, repository names, test output, raw event logs, tokens, secrets, and run artifacts.

Attach or paste $RUNNER_TEMP/abizor-feedback.md in an email to founders@abizor.dev. Abizor does not upload this file automatically. There is no hosted feedback endpoint.

Release evidence is maintained in the repository.

Current access boundary

Self-serve flow first. Hosted access later.

The current quickstart uses the GitHub Actions action Abizor/abizor-check-action@v1, which installs the public Abizor package on PyPI. If hosted access is not automated for you yet, email support. No sales call is required. The public CLI and GitHub Actions action can be tried without an Abizor account; paid founding access is separate from the first CI verified run.

Live in this quickstart: GitHub Actions verified run, GitHub Actions action, GitHub Check publishing, PyPI package install, static verified wheel path, Change Record JSON/Markdown, and verify-record.

Not live in this quickstart: hosted GitHub App/API, dashboard, and billing / hosted customer access.

Hosted app, hosted API, billing, dashboard, GitHub App installation, hosted merge automation, and hosted test execution are not part of this quickstart.

Safe boundary

The run record stays separate from GitHub output.

The Abizor CLI does not send repository content, pull request data, diffs, test output, event logs, or run artifacts to Abizor servers.

GitHub pull request data and GitHub Checks are read and published only inside your GitHub Actions workflow using the permissions you grant to that workflow.

AllowedRead existing PR metadata, read checks, run your configured verification command in the user's CI runner, upload artifacts, and optionally post the generated comment body.

Not allowedCreate PRs, merge PRs, deploy code, run customer shell commands on Abizor infrastructure, or treat a GitHub comment as the source of truth.

RecordThe Abizor event log and run record are durable evidence. Summaries, manifests, checks, and comments are readable outputs.

The GitHub Actions quickstart does not merge. Delivery uses a separate explicit CLI path such as abizor run-next --allow-merge, outside this quickstart.

Run Abizor on one ordinary PR.

The renamed GitHub Actions action target is Abizor/abizor-check-action@v1. It is the run-record-backed GitHub Actions action path for the current public package.

Ran Abizor? Send the generated summary or the redacted feedback export to founders@abizor.dev only if you choose.

Current package: abizor==0.1.8
Action target: Abizor/abizor-check-action@v1
Action repository: https://github.com/Abizor/abizor-check-action
PyPI: https://pypi.org/project/abizor/0.1.8/
Secondary wheel: https://abizor.dev/downloads/abizor-0.1.8-py3-none-any.whl
SHA-256: efbaef70e75636f66101a65238d6392afa02a027e26869a6744f278e6f662e8e

Open PyPI package View action repository Download verified wheel Email support