red-shirts/reviewdog-action-credo

Run credo with reviewdog

GitHub Action: Run credo with reviewdog

This action runs credo with reviewdog on pull requests to improve code review experience.

Inputs

github_token

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

level

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

reporter

Reporter of reviewdog command [github-pr-check,github-pr-review]. Default is github-pr-check. github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

Example usage

.github/workflows/reviewdog.yml

name: reviewdog
on: [pull_request]
jobs:
  credo:
    name: runner / credo
    runs-on: ubuntu-latest
    container:
      image: elixir:1.12-slim
    steps:
      - uses: actions/checkout@v2
      - name: Install Dependencies
        run: |
          mix local.rebar --force
          mix local.hex --force
          mix deps.get
      - name: credo
        uses: red-shirts/reviewdog-action-credo@v1
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-review # Change reporter.

reviewdog-action-credo's Issues

Respect credo exit code

Hello, credo has an :exit_option parameter that can be set to 0 so as a check to not error out (i.e return 0).

For example, I've set this to my project:

{Credo.Check.Design.TagTODO, [priority: :low, exit_status: 0]},

I'd like to see the list of TODOs when i Run the github action but I don't want my github action to error out if I only have TODOs. Unfortunately, the github action shows a red error even when I only have TODOs in my code.

Is there a way to resolve that ? i.e Display the TODOs but do not show an error unless there are other problems ?