Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 1.63 KB

README.md

File metadata and controls

51 lines (36 loc) · 1.63 KB
Raw

GitHub Action: Run markdownlint with reviewdog

Based on reviewdog/action-shellcheck

Docker Image CI Release

This action runs markdownlint 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,github-check]. Default is github-pr-check. github-pr-review can use Markdown and add a link to rule page in reviewdog reports.

markdownlint_flags

Optional. Flags of markdownlint command. Default: .

Example usage

.github/workflows/reviewdog.yml

name: reviewdog
on: [pull_request]
jobs:
  markdownlint:
    name: runner / markdownlint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1
      - name: markdownlint
        uses: prologic/action-markdownlint@v1
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          reporter: github-pr-review # Change reporter. (Only `github-pr-check` is supported at the moment).