GitHub Action¶

eigenhelm is available as a GitHub Action for CI integration.

Basic usage¶

- uses: actions/checkout@v4
- uses: metacogdev/eigenhelm@v0
  with:
    paths: "src/"

PR diff mode¶

Evaluate only files changed in a pull request:

name: Code Quality
on: [pull_request]

jobs:
  eigenhelm:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - uses: metacogdev/eigenhelm@v0
        with:
          diff: origin/main...HEAD

Strict mode¶

Fail the check if any file scores marginal or worse:

- uses: metacogdev/eigenhelm@v0
  with:
    diff: origin/main...HEAD
    strict: "true"

SARIF upload¶

Send results to GitHub Code Scanning:

- uses: metacogdev/eigenhelm@v0
  with:
    diff: origin/main...HEAD
    sarif-upload: "true"

Excluding files¶

There are three ways to exclude files from evaluation:

1. Action input¶

Pass glob patterns directly via the exclude input (comma or newline-separated):

- uses: metacogdev/eigenhelm@v0
  with:
    paths: "src/"
    exclude: "src/generated/**, *_pb2.py, vendor/**"

2. `.eigenhelmignore` file¶

Create a .eigenhelmignore file in your repository root with one pattern per line:

# Generated code
src/generated/**
*_pb2.py

# Vendored dependencies
vendor/**

Lines starting with # are comments. Patterns use fnmatch glob syntax.

3. `.eigenhelm.toml` config¶

Add an exclude array to your project config:

exclude = ["src/generated/**", "*_pb2.py", "vendor/**"]

All three methods can be combined — patterns from all sources are merged.

All inputs¶

Input	Default	Description
`paths`	`"."`	Files or directories to evaluate
`model`	(bundled)	Path to .npz model file
`diff`	(none)	Git revision range for changed files only
`format`	`"human"`	Output format: `human`, `json`, `sarif`
`classify`	`"true"`	Show accept/marginal/reject labels
`strict`	`"false"`	Treat marginal as reject
`lenient`	`"false"`	Treat marginal as accept
`exclude`	(none)	Glob patterns to exclude (comma or newline-separated)
`version`	(latest)	eigenhelm version to install
`sarif-upload`	`"false"`	Upload SARIF to GitHub Code Scanning

Outputs¶

Output	Description
`sarif-file`	Path to SARIF file (when applicable)
`exit-code`	Exit code from evaluation