Brakeman Scan #5976
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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 | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| # The branches below must be a subset of the branches above | |
| branches: [ main ] | |
| schedule: | |
| - cron: '22 13 * * 3' | |
| permissions: | |
| contents: read | |
| jobs: | |
| brakeman-scan: | |
| permissions: | |
| contents: read # for actions/checkout to fetch code | |
| security-events: write # for github/codeql-action/upload-sarif to upload SARIF results | |
| name: Brakeman Scan | |
| runs-on: ubuntu-latest | |
| steps: | |
| # Checkout the repository to the GitHub Actions runner | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| # Customize the ruby version depending on your needs | |
| - name: Setup Ruby | |
| uses: ruby/setup-ruby@v1 | |
| with: | |
| ruby-version: '3.0' | |
| - 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 src/oc-id --skip-files habitat/ | |
| # 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 |