Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.59 KB

pre-commit-hooks.md

File metadata and controls

47 lines (29 loc) · 1.59 KB
Raw

Pre-Commit Hooks

Pre-Commit is a framework for managing and maintaining multi-language pre-commit hooks. This allows running Regal automatically whenever (and as the name implied, before )a Rego file is about to be committed.

To use Regal with pre-commit, add this to your .pre-commit-config.yaml

- repo: https://github.com/StyraInc/regal
  rev: v0.7.0 # Use the ref you want to point at
  hooks:
    - id: regal-lint
  # -   id: ...

Hooks Available

regal-lint

commit-msg hook

Runs Regal against all staged .rego files, aborting the commit if any fail.

  • requires the go build chain is installed and available on $PATH
  • will build and install the tagged version of Regal in an isolated GOPATH
  • ensures compatibility between versions

regal-lint-use-path

commit-msg hook

Runs Regal against all staged .rego files, aborting the commit if any fail.

  • requires the regal package is already installed and available on $PATH.

regal-download

commit-msg hook

Runs Regal against all staged .rego files, aborting the commit if any fail.

  • Downloads the latest regal binary from Github.

Community

If you'd like to discuss the Regal pre-commit hooks, or just talk about Regal in general, please join us in the #regal channel in the Styra Community Slack!