Skip to content
Run misspell with reviewdog
Dockerfile Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
testdata
Dockerfile
README.md
action.yml
entrypoint.sh

README.md

GitHub Action: Run misspell with reviewdog

Docker Image CI Release

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

sample annotation

Inputs

github_token

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

locale

Optional. -locale flag of misspell. (US/UK)

level

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

reporter

Optional. Reporter of reviewdog command [github-pr-check,github-pr-review]. It's same as -reporter flag of reviewdog.

Example usage

.github/workflows/reviewdog.yml

name: reviewdog
on: [pull_request]
jobs:
  misspell:
    name: runner / misspell
    runs-on: ubuntu-latest
    steps:
      - name: Check out code.
        uses: actions/checkout@v1
      - name: misspell
        uses: reviewdog/action-misspell@v1
        with:
          github_token: ${{ secrets.github_token }}
          locale: "US"
You can’t perform that action at this time.