From e3b96e1659a958dfdb53fbdbd4a88ceda1b58a48 Mon Sep 17 00:00:00 2001 From: Claire Date: Wed, 3 Mar 2021 23:53:54 +0100 Subject: [PATCH] Enable brakeman github workflow --- .github/workflows/brakeman-analysis.yml | 44 +++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 .github/workflows/brakeman-analysis.yml diff --git a/.github/workflows/brakeman-analysis.yml b/.github/workflows/brakeman-analysis.yml new file mode 100644 index 0000000000..ac51638988 --- /dev/null +++ b/.github/workflows/brakeman-analysis.yml @@ -0,0 +1,44 @@ +# This workflow integrates Brakeman with GitHub's Code Scanning feature +# Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications + +name: Brakeman Scan + +# This section configures the trigger for the workflow. Feel free to customize depending on your convention +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + brakeman-scan: + name: Brakeman Scan + runs-on: ubuntu-latest + steps: + # Checkout the repository to the GitHub Actions runner + - name: Checkout + uses: actions/checkout@v2 + + # Customize the ruby version depending on your needs + - name: Setup Ruby + uses: actions/setup-ruby@v1 + with: + ruby-version: '2.7' + + - name: Setup Brakeman + env: + BRAKEMAN_VERSION: '4.10' # SARIF support is provided in Brakeman version 4.10+ + run: | + gem install brakeman --version $BRAKEMAN_VERSION + + # Execute Brakeman CLI and generate a SARIF output with the security issues identified during the analysis + - name: Scan + continue-on-error: true + run: | + brakeman -f sarif -o output.sarif.json . + + # Upload the SARIF file generated in the previous step + - name: Upload SARIF + uses: github/codeql-action/upload-sarif@v1 + with: + sarif_file: output.sarif.json