Skip to Content

Pull request checks

A GitHub Action that comments on a pull request when it makes a project fact stale, so the whole team sees it before it merges.

When a pull request changes code that a fact in .woolly/woolly.md points at, Woolly comments on it.

Woolly checked 12 project facts against this change. 1 fact went stale.

FactWhat changed
The IMU chip select is GPIO 5main/pins.h#IMU_CS: 5 is no longer there in 229f599

After this merges, run woolly review to confirm, fix or retire each one. Nothing is deleted.

Nobody on the team needs Woolly installed for this. The facts come from .woolly/woolly.md in the repo, and the check runs on GitHub with no model and no network calls beyond downloading Woolly.

Set it up

Add .github/workflows/woolly.yml to your repo.

name: Woolly
on: pull_request

permissions:
  contents: read
  pull-requests: write

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: rjcuff/woolly@main

That's it. It checks the repo's agent files, like CLAUDE.md, AGENTS.md and Cursor rules, with no setup. See Check your agent files. With project memory committed by woolly init, it checks those facts too. See Stale facts. fetch-depth: 0 lets Woolly read the history it needs to tell what changed.

How it works

  1. It installs Woolly with the same script as Download.
  2. It reads the facts from .woolly/woolly.md into a Woolly of its own for the job.
  3. It runs woolly check --markdown --base <the pull request's base commit>. Facts were true on the branch you're merging into, so that's what the change is compared against.
  4. It checks every line in the repo's agent files and reports the ones this change made stale. Lines that were already out of date are listed separately, folded away.
  5. It writes the report to the job summary. When something went stale, it comments on the pull request. If it commented before, it updates that comment instead of adding another.

Options

InputDefaultWhat it does
commenttrueComment on the pull request when something goes stale. false only writes the job summary
fail-on-stalefalseFail the job when the change makes a fact stale
tokengithub.tokenThe token for commenting. It needs pull-requests: write

The action also sets two outputs, stale and checked, for later steps.

Pull requests from forks

GitHub gives pull requests from forks a token that can't comment. The check still runs and the report is still in the job summary.

Run the same check yourself

woolly check --markdown --base origin/main

On this page