Skip to content

HomeDocsInstall

Install

Wire the workflow.

This repository already runs Receipt on itself. Another public Vercel repo can use the same action.

secrets:
  LT_USERNAME
  LT_ACCESS_KEY
  GEMINI_API_KEY
  RECEIPT_GIT_TOKEN
vars:
  RECEIPT_PRODUCTION_URL
  1. Add repository secrets LT_USERNAME, LT_ACCESS_KEY, GEMINI_API_KEY, and RECEIPT_GIT_TOKEN (a fine-grained PAT that can push fixer commits). Never print their values.
  2. Set RECEIPT_PRODUCTION_URL as a repository variable. The action uses it when the preview never returns HTTP 200.
  3. Copy tests/receipt_checkout_test.md and the <!-- kane:how-to-test --> block, then add a workflow whose Receipt step passes production-url, allowlist, and the three Vercel env values below.
uses: ohjay-official/receipt@main
with:
  test-file: tests/receipt_checkout_test.md
  production-url: ${{ vars.RECEIPT_PRODUCTION_URL }}
  allowlist: "<your app path>/**"
  username: ${{ secrets.LT_USERNAME }}
  access-key: ${{ secrets.LT_ACCESS_KEY }}
  gemini-api-key: ${{ secrets.GEMINI_API_KEY }}
  git-token: ${{ secrets.RECEIPT_GIT_TOKEN }}
env:
  RECEIPT_VERCEL_PROJECT: <your-vercel-project>
  RECEIPT_VERCEL_SCOPE: <your-vercel-team-slug>
  RECEIPT_WAIT_FOR_VERCEL_STATUS: ${{ github.event_name == 'pull_request' && 'true' || 'false' }}

Pin to a commit SHA for stability: ohjay-official/receipt@<sha>. This install has not been verified on a second repo. This repository’s own workflow listens on pull_request and waits for the Vercel commit status.

Source: github.com/ohjay-official/receipt · Configuration