Proofsource and the GitHub Action: a pull request check for what AI quotes
Add the Proofsource action to a pull request workflow and every PR gets one comment, kept up to date on each push, warning when the change removes a sentence AI answers quote about your brand. It shows each fix's answer preview, labeled Preview, and can fail the job if you want it to.
on: pull_request
permissions:
contents: read
pull-requests: write
jobs:
proofsource:
runs-on: ubuntu-latest
steps:
- uses: proofsource/proofsource-cli/action@v1
with:
api-key: ${{ secrets.PROOFSOURCE_API_KEY }}
brand: brd_liftback
fail: "false"Proofsource and the GitHub Action, in short
The facts, ready to quote.
- Stage
- Preview: the action works today, and its one-line marketplace release is on the way
- Connects with
- A pull_request workflow, an API key secret and a brand id
- Access it needs
- A read API key, plus pull-requests write for the comment
- Comments
- One comment per pull request, updated on each push
- Fail option
- Set fail to true to fail the job when a quoted sentence is removed
- Cost
- Reads answers Proofsource has already saved, so a push never starts a new scan
Preview Preview means the action works today and you can run it in your own workflows. Its short, one-line release in the GitHub Marketplace is still on the way, so for now you point your workflow at the action's source.
Why we love the GitHub Action
In the makers' own words, from their own pages. Proofsource builds on it, never around it.
Automation built into the repo
GitHub Actions builds, tests and deploys right from GitHub, and can be triggered by any GitHub event, not only a push.
From github.comSecrets kept safe
Encrypted secrets can be stored per repository, environment or organization, so an API key never has to sit in a workflow file.
From github.comA marketplace of ready-made actions
The GitHub Marketplace holds thousands of actions that connect GitHub to other tools, so a new check is a few lines of YAML.
From github.comHow Proofsource uses the GitHub Action
Runs the Proofsource pull request check in GitHub Actions with one updating comment per PR, and can fail the job.
- Know
Read your saved answers
The action reads the answers Proofsource has already stored for the brand, so it adds no new scan cost.
- Act
Check the diff
It reads the pull request diff and spots a removed sentence that AI answers quote.
- Show
Comment once, keep it fresh
It posts one comment on the pull request and updates it on each push, with each fix's answer preview labeled Preview.
- Prove
Fail the job if you choose
Set fail to true and the job fails when a quoted sentence is removed, so the change is reviewed first.
Set up the GitHub Action in 4 steps
Make an API key
In Proofsource, open Settings, then Developers. A read key is enough. Store it as a GitHub secret named PROOFSOURCE_API_KEY.
Add the workflow
Create a workflow on pull_request with contents read and pull-requests write, and add the Proofsource action step.
Set the inputs
Pass api-key from the secret and the brand id. Leave fail at false at first, and comment at true.
Open a pull request
The check runs and posts its comment. Switch fail to true when you want it to block.
| Page | Fix it ships | Answer preview |
|---|---|---|
| /returns | Refund times FAQ | Preview |
| /exchanges | Size exchange guide | Preview |
| /pricing | Plans comparison | Preview |
Preview is an AI estimate from today's answers, never proof.
What you unlock with the GitHub Action
A check on every pull request
Catch a removed quoted sentence before it merges.
One comment, always current
The comment is updated on each push, never duplicated.
Can block the merge
Set fail to true to fail the job on a removed quoted sentence.
Reads saved data only
No new scan runs, so it is cheap on every push.
Answer previews
Each fix's stored answer shown, labeled Preview.
A key you control
Keep the key as a GitHub secret and revoke it in Settings.
Google AI OverviewsGoogle AI Mode
Questions about Proofsource and the GitHub Action
What does the GitHub Action do?
It runs the Proofsource pull request check in GitHub Actions. It warns when a change removes a sentence AI answers quote and keeps one up to date comment per pull request.
What does Preview mean for this integration?
The action works today and you can run it in your own workflows. Its short, one-line release in the GitHub Marketplace is still on the way, and we call it Preview until it lands.
What access does it need?
A read Proofsource API key stored as a secret, a brand id, and pull-requests write permission so it can post its comment.
Can it block a merge?
Yes. Set fail to true and the job fails when a quoted sentence is removed. It defaults to false.
Does it run a new scan on every push?
No. It reads only the saved answers Proofsource already has, so it adds no scan.
What are the Preview labels?
Each fix's stored answer preview is labeled Preview. It is an AI estimate from today's answers and never proof.
How do I remove it?
Delete the step from your workflow and revoke the API key under Settings, Developers in Proofsource.
Pairs well with the GitHub Action
Put the GitHub Action to work for your AI visibility.
Scan your brand, connect the GitHub Action, and see what AI says about you on up to 10 engines.
Google AI OverviewsGoogle AI Mode