Skip to content

guibranco/github-infisical-secrets-check-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

160 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

GitHub Infisical secrets check Action

GitHub repo GitHub last commit GitHub license

CI Test wakatime

🚨 :octocat: A GitHub action to check and report secret leaks in the repository using Infisical CLI.


Usage

The following workflow step will scan for secret leaks in your repository.

- name: Infisical Secrets Check
  id: secrets-scan
  uses: guibranco/github-infisical-secrets-check-action@v5.0.1

Inputs

Input Description Required Default
GH_TOKEN GitHub token to add comments in pull requests No ${{ github.TOKEN }}
ADD_COMMENT Whether to comment results in the pull request No true

Outputs

Output Description
secrets-leaked The number of secrets leaked found by the Infisical CLI tool

Examples

Basic usage with default settings

name: Infisical secrets check

on:
  workflow_dispatch:
  pull_request:

jobs:
  secrets-check:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: Infisical Secrets Check
        uses: guibranco/github-infisical-secrets-check-action@v5.0.1

With a custom GitHub token

name: Infisical secrets check

on:
  workflow_dispatch:
  pull_request:

jobs:
  secrets-check:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: Infisical Secrets Check
        uses: guibranco/github-infisical-secrets-check-action@v5.0.1
        with:
          GH_TOKEN: ${{ secrets.CUSTOM_GH_TOKEN }}

Remember to add the repository secret CUSTOM_GH_TOKEN.


Disable PR comments

name: Infisical secrets check

on:
  workflow_dispatch:
  pull_request:

jobs:
  secrets-check:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: Infisical Secrets Check
        uses: guibranco/github-infisical-secrets-check-action@v5.0.1
        with:
          ADD_COMMENT: false

Using outputs in subsequent steps

name: Infisical secrets check

on:
  workflow_dispatch:
  pull_request:

jobs:
  secrets-check:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - name: Infisical Secrets Check
        id: secrets-scan
        uses: guibranco/github-infisical-secrets-check-action@v5.0.1
        
      - name: Handle secrets found
        if: steps.secrets-scan.outputs.secrets-leaked > 0
        run: |
          echo "Found ${{ steps.secrets-scan.outputs.secrets-leaked }} leaked secrets!"
          # Add your custom handling logic here

Sample outputs

Success - βœ… No secrets leaked

success


Failure - 🚨 Secrets leaked!

Version 5 introduces an improved remediation workflow:

When secrets are detected, the action now:

  • Shows detected fingerprints
  • Generates .infisicalignore update suggestions
  • Provides a Commit suggestion button directly inside the PR comment
  • Automatically creates or updates .infisicalignore
  • Prevents duplicate fingerprints

This allows contributors to fix false positives without leaving the pull request UI.

failure


Tool Failure - ⚠️ Unable to complete scan

When the Infisical CLI fails to run (due to network issues, API rate limiting, etc.), the action will post a clear error message:

  • Explains that this is a tool failure, not a security issue
  • Provides suggestions for resolution (re-run workflow, check logs)
  • Includes a link to workflow logs for debugging
  • Clarifies that the failure doesn't mean secrets were found

Features

  • πŸ” Comprehensive scanning using the latest Infisical CLI
  • πŸ’¬ Smart PR comments with structured scan results
  • 🧠 Interactive remediation workflow (new in v5) with commit suggestion support
  • πŸ“ Automatic .infisicalignore generation/update suggestions
  • 🧹 Duplicate fingerprint prevention
  • πŸ“Š Detailed CSV and Markdown reports
  • πŸ”’ Fork-safe execution
  • ⚑ Efficient dependency caching
  • πŸ›‘οΈ Robust failure detection and reporting
  • πŸ“Ž Workflow-friendly outputs
  • πŸ”§ Configurable comment behavior

Error Handling

Version 4 introduced improved error handling that prevents confusing empty comments.

Version 5 builds on this by improving remediation guidance:

  • Generates commit suggestions for ignore rules
  • Prevents duplicate ignore entries
  • Improces PR workflow ergonomics
  • Keeps scan failures clearly separated from security failures

The action will fail the workflow appropriately, providing meaningful feedback on what went wrong and how to resolve it.


Permissions

The action requires the following permissions:

permissions:
  contents: read
  pull-requests: write

Ignoring False Positives

If the scan detects false positives:

Version 5 allows you to fix them directly from the PR comment.

The action now automatically:

  1. Detects whether .infisicalignore exists
  2. Creates the file if missing
  3. Appends fingerprints if present
  4. Removes duplicates automatically
  5. Generates a Commit suggestion button

Simply click the suggestion button inside the PR comment to apply the ignore list instantly.

Manual fallback (still supported):

Create a .infisicalignore file at repository root:

fingerprint_value_here
another_fingerprint_here

About

🚨 :octocat: A GitHub action to check and report secrets leaks in the repository using Infisical CLI

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors