GitHub Action
Bearer Action
Run Bearer as a GitHub Action.
steps:
- uses: actions/checkout@v3
- uses: bearer/bearer-action@v1.0
steps:
- uses: actions/checkout@v3
- name: Bearer
uses: bearer/bearer-action@v1.0
with:
config-file: '/some/path/bearer.yml'
only-rule: 'ruby_lang_cookies,ruby_lang_http_post_insecure_with_data'
skip-path: 'users/*.go,users/admin.sql'
name: Bearer
on:
push:
branches:
- main
permissions:
contents: read
jobs:
rule_check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Run Report
id: report
uses: bearer/bearer-action@v1.0
- id: summary
name: Display Summary
uses: actions/github-script@v6
with:
script: |
// github does not support multiline outputs so report is encoded
const report = decodeURIComponent(`${{ steps.report.outputs.rule_breaches }}`);
const passed = `${{ steps.report.outputs.exit_code }}` == "0";
if(!passed){ core.setFailed(report); }
you can see this workflow in action on our demo repo
Optional Specify the Bearer version to use. This must match a Bearer release name.
Optional Specify the comma-separated scanner to use e.g. sast,secrets
Optional configuration file path
Optional Specify the comma-separated IDs of the rules to run; skips all other rules.
Optional Specify the comma-separated IDs of the rules to skip; runs all other rules.
Optional Specify the comma-separated paths to skip. Supports wildcard syntax, e.g. users/*.go,users/admin.sql
Optional Specify which severities are included in the report as a comma separated string, e.g. critical,medium
Details of any rule breaches that occur. This is URL encoded to work round GitHub issues with multiline outputs.
Exit code of the binary, 0 indicates a pass