https://github.com/red-shirts/reviewdog-action-credo

Run credo with reviewdog
https://github.com/red-shirts/reviewdog-action-credo

beam credo elixir elixir-lang github-pr-review review reviewdog

Last synced: 9 months ago
JSON representation

Run credo with reviewdog

• Host: GitHub
• URL: https://github.com/red-shirts/reviewdog-action-credo
• Owner: red-shirts
• Created: 2019-10-08T11:51:24.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-11T21:16:54.000Z (almost 2 years ago)
• Last Synced: 2024-04-15T07:06:55.238Z (over 1 year ago)
• Topics: beam, credo, elixir, elixir-lang, github-pr-review, review, reviewdog
• Language: Elixir
• Homepage:
• Size: 21.5 KB
• Stars: 22
• Watchers: 3
• Forks: 13
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# GitHub Action: Run credo with reviewdog

[![Docker Image CI](https://github.com/red-shirts/reviewdog-action-credo/workflows/Docker%20Image%20CI/badge.svg)](https://github.com/red-shirts/reviewdog-action-credo/actions)

[![Release](https://img.shields.io/github/release/red-shirts/reviewdog-action-credo.svg?maxAge=43200)](https://github.com/red-shirts/reviewdog-action-credo/releases)

This action runs [credo](https://github.com/rrrene/credo) with

[reviewdog](https://github.com/reviewdog/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](.github/workflows/reviewdog.yml)

```yml

name: reviewdog

on: [pull_request]

jobs:

  credo:

    name: runner / credo

    runs-on: ubuntu-latest

    container:

      image: elixir:1.16-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.

```