Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
alert-octagon

GitHub Action

Run redpen with reviewdog

v1.4.1

Run redpen with reviewdog

alert-octagon

Run redpen with reviewdog

🐶Run redpen with reviewdog on pull requests to improve document writing experience

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Run redpen with reviewdog

              
  uses: tsuyoshicho/action-redpen@v1.4.1
Learn more about this action in tsuyoshicho/action-redpen

Choose a version

GitHub Action: Run redpen with reviewdog

Docker Image CI Release

This action runs redpen with reviewdog on pull requests to improve text review experience.

based on reviewdog/action-vint

github-pr-check example

github-pr-review example

github-check example

Inputs

github_token

Required. Default is ${{ 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-check,github-pr-review]. Default is github-pr-review. It's same as -reporter flag of reviewdog.

github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

filter_mode

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

fail_on_error

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

reviewdog_flags

Optional. Additional reviewdog flags

basedir

redpen target document base directory (i.e. doc) Default: ..

targets

redpen target file glob (i.e. *.md) Search recursively. Default: *.

config

redpen config file path (i.e. config/redpen-conf-en.xml) Default: `` (use redpen default rule).

Example usage

.github/workflows/reviewdog.yml

name: reviewdog
on: [pull_request]
jobs:
  redpen:
    name: runner / redpen
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          submodules: true
      - name: redpen-github-pr-check
        uses: tsuyoshicho/action-redpen@v1
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-check
          basedir: "doc"
          targets: "*.md"
          config: "config/redpen-conf-ja.xml"
      - name: redpen-github-check
        uses: tsuyoshicho/action-redpen@v1
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-check
          basedir: "doc"
          targets: "*.md"
          config: "config/redpen-conf-ja.xml"
      - name: redpen-github-pr-review
        uses: tsuyoshicho/action-redpen@v1
        with:
          github_token: ${{ secrets.github_token }}
          reporter: github-pr-review
          basedir: "doc"
          targets: "*.md"
          config: "config/redpen-conf-ja.xml"