README.md

github-action-detect-secrets

About

This is github action for running detect-secrets hook.

it will run againts all files managed in git repository

Prerequisites

create a baseline file for your repository

please refer: https://github.com/Yelp/detect-secrets?tab=readme-ov-file#adding-secrets-to-baseline

Usage

- uses: sensyn-robotics/github-action-detect-secrets@v1
  with:
    # Baseline file for detect-secrets, relative to the mount-path
    # Default; .secrets.baseline
    baseline: '.secrets.baseline'

    # Version of detect-secrets
    # When not specified, use latest
    detect-secrets-version: "1.5.0"

Basic:

steps:
  - uses: actions/checkout@v4
  - name: Run DetectSecrets
    uses: sensyn-robotics/github-action-detect-secrets@v1