Skip to content

Docs / Running Lintsure

GitHub Action

Run Lintsure on every pull request, inside your own GitHub Actions runner.

The action installs Node.js 22, runs the Lintsure CLI on your checked-out code, and adds the report to the job summary. Your code stays in your runner; nothing is uploaded.

The action builds the engine from lintsure/lintsure at the version you choose, so it works today without any npm package or secrets.

Add it

Create .github/workflows/lintsure.yml:

name: lintsure
on: [pull_request]
jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: lintsure/action@v1
        with:
          frameworks: gdpr,soc2   # optional, default: all available
          fail-on: gap            # gap | partial | none

Inputs

Input Default What it does
path . Folder to check
frameworks empty Comma-separated framework ids. Empty means lintsure.config.yaml, or all available.
fail-on gap gap fails the job on any Gap, partial on any Gap or Partial, none never fails
ref main Which version of the engine to build and run: a branch, tag or commit. Pin a commit for repeatable results.

What you’ll see

  • The job fails or passes according to fail-on.
  • The full Markdown report appears in the job summary.
  • lintsure-report.json is written in the workspace, and its path is the report output, so later steps can read it.
  • Every report includes the disclaimer and the next steps a person still needs to take.

Source: github.com/lintsure/action.

Lintsure is a readiness tool, not an audit or legal advice. Results cover code only; a qualified person should review them. Disclaimer