Skip to content

README.md

Latest commit

 

History

History
executable file
·
71 lines (45 loc) · 2.37 KB

README.md

File metadata and controls

executable file
·
71 lines (45 loc) · 2.37 KB
Raw

devsecops-hooks

OpenSSF Scorecard OpenSSF Best Practices Ministry of Justice Repository Compliance

Pre-commit hooks for Ministry of Justice repositories.

Prerequisites

prek and gitleaks must both be installed and available on your PATH. On macOS:

brew install prek gitleaks

pre-commit can be used in place of prek (pip install pre-commit); all commands in this document are compatible with both. For other platforms, refer to the upstream install instructions: prek, gitleaks.

Usage

Add the following to your repository's .pre-commit-config.yaml, replacing <SHA> with a commit SHA from this repository (see releases):

repos:
  - repo: https://github.com/ministryofjustice/devsecops-hooks
    rev: <SHA>
    hooks:
      - id: baseline

Then install the hook:

prek install

The hook will run automatically on git commit. To run it manually:

prek run baseline --all-files

Pinning to a commit SHA

Use a commit SHA rather than a tag in rev:. Tags are mutable — a SHA guarantees you are running exactly what you reviewed. Find the SHA for any release on the releases page or by running:

git ls-remote https://github.com/ministryofjustice/devsecops-hooks refs/tags/v<version>

Hooks

Hook Description
baseline Scans staged changes for hardcoded secrets using gitleaks

Contributing

Raise an issue or open a pull request. See CHANGELOG.md for release history.

Licence

MIT — Crown Copyright (Ministry of Justice)