Git Product home page Git Product logo

dependabot-alert-export's Introduction

dependabot-alert-export

Export the Dependabot alerts as CSV file from a repo

This GitHub action helps to export the Dependabot alerts to a CSV file. One can define a workflow to run or triger based on specific event to capture all Dependabot alerts to a CSV file for further analysis.

Release

GitHub Marketplace : https://github.com/marketplace/actions/dependabot-alert-export

How to Use the Action

PAT Token

Create a PAT token to get access to the Dependabot alerts. Pass this token as an input to the action - GITHUB_TOKEN

action in workflow

Include the dependabot-alert-export action in your workflow.

Following is the sample code for integrating this action with your workflow

steps:               
      - name: Export Dependabot alerts
        uses: ambilykk/[email protected]
        with:        
          GITHUB_TOKEN: ${{secrets.GH_TOKEN}}
          org_name: 'ORG_NAME'
          repo_name: 'REPO_NAME'
          csv_path: data/vulnerability.csv
          
      - name: Upload Vulnerability report
        uses: actions/upload-artifact@v3
        with:
           name: vulnerability_report
           path: data/vulnerability.csv          

Parameters

Name Required Description
GITHUB_TOKEN Yes PAT Token for access
org_name Yes GitHub Organization Name
repo_name Yes GitHub Repository Name
csv_path Yes CSV file path

Exported Fields

Following fields are included in the Vulnerability Report

  • Vulnerability Id
  • Dependency Scope (DEVELOPMENT or RUNTIME)
  • State (DISMISSED, FIXED or OPEN)
  • Created At
  • Manifest File Name
  • Vulnerability Version Range
  • Package Name
  • GHSA Id (The ID of the vulnerability in the GitHub Security Advisory Database)
  • Severity
  • Summary
  • Link
  • Description
  • Dismissed At (for Dismissed alerts)
  • Dismiss Reason
  • Dismiss Comment
  • Fixed At (for Fixed alerts)
  • Fix Reason

Report

Vulnerability report in CSV format will be available as part of the build artifacts for download

Screenshot 2022-09-18 at 1 23 26 PM

License

The scripts and documentation in this project are released under the MIT License

dependabot-alert-export's People

Contributors

affrae avatar ambilykk avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.