GitHub Action: Run bundler-audit with reviewdog 🐶

This action runs bundler-audit with reviewdog on pull requests to improve code review experience.

Input

github_token

GITHUB_TOKEN. Default is ${{ github.token }}.

bundler_audit_version

Optional. Set bundler-audit version. Possible values:

• empty or omit: install latest version
• gemfile: install version from Gemfile (Gemfile.lock should be presented, otherwise it will fallback to latest bundler version)
• version (e.g. 1.9.0): install said version

bundler_audit_flags

Optional. bundler-audit flags. (bundler-audit check --format json <bundler_audit_flags>).

skip_install

Optional. Do not install bundler-audit or its extensions. Default: false.

use_bundler

Optional. Run bundler-audit with bundle exec. Default: false.

tool_name

Optional. Tool name to use for reviewdog reporter. Useful when running multiple actions with different config.

level

Optional. Report level for reviewdog [info, warning, error]. It's same as -level flag of reviewdog.

reporter

Optional. Reporter of reviewdog command [github-pr-check, github-check, github-pr-review]. The default is github-pr-check.

filter_mode

Optional. Filtering mode for the reviewdog command [added, diff_context, file, nofilter]. Default is added.

fail_level

Optional. If set to none, always use exit code 0 for reviewdog. Otherwise, exit code 1 for reviewdog if it finds at least 1 issue with severity greater than or equal to the given level. Possible values: [none, any, info, warning, error]. Default is none.

fail_on_error

Optional. Deprecated, use fail_level instead. Exit code for reviewdog when errors are found [true, false]. Default is false.

reviewdog_flags

Optional. Additional reviewdog flags.

workdir

Optional. The directory from which to look for and run bundler-audit. Default ..

Example usage

name: reviewdog
on: [pull_request]
jobs:
  bundler_audit:
    name: runner / bundler_audit
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@v2
      - uses: ruby/setup-ruby@v1
        with:
          ruby-version: 3.0.0
      - name: bundler_audit
        uses: codeur/action-bundler-audit@v1
        with:
          bundler_audit_version: gemfile
          # Change reviewdog reporter if you need [github-check,github-pr-review,github-pr-check].
          reporter: github-pr-review

Dev

Release new version

1. Create a Pull Request with changes.
2. Add one of the following labels to the PR:
   • bump:major: Bump major version (e.g. v1.0.0 -> v2.0.0)
   • bump:minor: Bump minor version (e.g. v1.0.0 -> v1.1.0)
   • bump:patch: Bump patch version (e.g. v1.0.0 -> v1.0.1)
3. Merge the PR.
4. The release workflow will automatically bump the version, create a release, and update major/minor tags (e.g. v1).