Skip to content
shield

GitHub Action

Security Scan and Comment Action

1.0.10 Latest version

Security Scan and Comment Action

shield

Security Scan and Comment Action

Runs various open source security tools and then comments on PRs with results

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Security Scan and Comment Action

uses: dacoburn/security-tools@1.0.10

Learn more about this action in dacoburn/security-tools

Choose a version

Security Tools Scanning

The purpose of this action is to run various security tools, process their output, and then comment the results on a PR. It is expected to only run this on PRs

Example Usage

name: Security Scan Workflow
on:
  pull_request:
    types: [opened, synchronize, edited]

jobs:
  security-scan:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write
      contents: read

    steps:
      - name: Checkout code
        uses: actions/checkout@v4.2.1
      - name: Run Security Scan and Comment Action
        uses: dacoburn/security-tools@1.0.10
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          trufflehog_exclude_dir: "node_modules/*,vendor,.git/*,.idea"
          bandit_exclude_dir: "tests,migrations,tests,test,.venv,venv"
          bandit_rules: "B101,B102,B105,B106,B107,B110,B603,B605,B607"
          gosec_rules: "medium"
          gosec_exclude_dir: "tests,migrations,tests,test,.venv,venv"
          trivy_rules: ""
          trivy_exclude_dir: "/path/to/ignore"