Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
shield

GitHub Action

goKakashi Scan

v0.0.1

goKakashi Scan

shield

goKakashi Scan

A GitHub Action to trigger on demand and store image scans reports

Installation

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

              

- name: goKakashi Scan

uses: shinobistack/gokakashi-scan-action@v0.0.1

Learn more about this action in shinobistack/gokakashi-scan-action

Choose a version

GoKakashi Scan Action

This GitHub Action allows you to scan images on demand and store the reports and log the report(s) URL in CICD for vulnerabilities using GoKakashi.

Inputs

  • api_host: The base URL of the GoKakashi API (required)
  • api_token: API token for authentication with GoKakashi (required)
  • image_name: The Docker image to scan (required)
  • severity: Comma-separated list of severity levels to report (default: 'CRITICAL') (required)
  • publish: The publish path for the scan report (default: 'report_private')
  • fail_on_severity: Comma-separated list of severity levels to fail the job on (default: 'CRITICAL')

Outputs

  • report_url: URL of the scan report

Example usage

name: Scan Docker Image

on: [push]

jobs:
  scan:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v2

    - name: Scan Docker image
      uses: gokakashi/gokakashi-scan-action@v1
      with:
        api_host: 'https://api.gokakashi.com'
        api_token: ${{ secrets.GOKAKASHI_API_TOKEN }}
        image_name: 'myorg/myimage:latest'
        severity: 'HIGH,CRITICAL'
        fail_on_severity: 'CRITICAL'

    - name: Get the scan report URL
      run: echo "The scan report URL is ${{ steps.scan.outputs.report_url }}"

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author This action is maintained by the goKakashi team. For questions or support, please open an issue in the GitHub repository.