Skip to content
Pullminder Docs

Overview

The official Pullminder GitHub Action (pullminder/action) wraps the Pullminder CLI so you can validate Pullminder rule registries directly from a GitHub workflow without writing any glue code.

Current scope: the action is currently focused on registry validation — running pullminder registry validate (or lint) against a registry checkout, then posting the result as a PR comment. If you want PR risk scoring or general CI annotations on a consumer repository today, run the Pullminder CLI directly. Expanded modes (pr-review, ci) are tracked on the action repository.

What it does

Section titled “What it does”

When invoked from a workflow, the action:

  1. Detects the runner OS and architecture (linux/amd64, linux/arm64, darwin/amd64, darwin/arm64).
  2. Resolves the requested CLI version (latest or a pinned vX.Y.Z).
  3. Downloads the matching release artifact from pullminder/cli and verifies its SHA256 against the published checksums.txt. A mismatch fails the run before the binary is made executable.
  4. Caches the binary across runs keyed by version + platform.
  5. Runs pullminder registry validate (default) or pullminder registry lint against the configured working-directory.
  6. Posts the CLI output as a PR comment when comment: "true" (the default) and the trigger is pull_request.
  7. Exits with the CLI’s status code so a failed validation fails the job.

When to use it

Section titled “When to use it”
Use casePick this
Maintaining a Pullminder rule registrypullminder/action@v1 with command: validate --strict
Linting a registry before publishingpullminder/action@v1 with command: lint
Running risk scoring on a consumer repo’s PRspullminder ci directly
Producing SARIF / JUnit / annotations from CLI outputpullminder ci directly

If you maintain a registry, the action is the shortest path from clone to comment. For everything else, the CLI is more flexible today.

Versioning

Section titled “Versioning”

Pin the action to a major version in production:

- uses: pullminder/action@v1

Or pin to an exact CLI version through the version input — useful if you want bit-for-bit reproducibility across runs. See Advanced.

Source

Section titled “Source”