GitHub Action: Run fasterer with reviewdog 🐶

This action runs fasterer with reviewdog on pull requests to improve code review experience. Fasterer will suggest some speed improvements your ruby-code.

Examples

With github-pr-check

By default, with reporter: github-pr-check an annotation is added to the line:

With github-pr-review

With reporter: github-pr-review a comment is added to the Pull Request Conversation:

Inputs

github_token

Required. Must be in form of github_token: ${{ secrets.github_token }}'.

fasterer_version

Optional. Set fasterer 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. 0.10.0): install said version

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. By default - error.

reporter

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

Usage

.github/workflows/main.yml:

name: reviewdog
on: [pull_request]
jobs:
  fasterer:
    name: runner / fasterer
    runs-on: ubuntu-latest
    steps:
      - name: Check out code
        uses: actions/checkout@50fbc622fc4ef5163becd7fab6573eac35f8462e # v1.2.0
      - name: fasterer
        uses: vk26/action-fasterer@14efb2322db70c51b0211343d444adf457ff4666 # v1
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-review # Default is github-pr-check

Sponsor

License

MIT