Skip to content

Release version 0.0.3

Pre-release
Pre-release
Compare
Choose a tag to compare
@gaurav-nelson gaurav-nelson released this 26 Aug 00:09
· 8 commits to master since this release

Github action: Lint with Vale ✅❎

Automatically lint all modified text files in your GitHub pull requests. This GitHub action uses Vale to lint prose. Optional: Add errors as comments on PR.

Lint with Vale

The github-action-vale-lint checks all modified text (including markup) files and reports failure on error.

Vale error list

Prerequisite

You must have Vale configuration file .vale.ini in your repository.

How to use

  1. Create a new file in your repository .github/workflows/action.yml.

    touch .github/workflows/action.yml
  2. Copy-paste the folloing workflow in your action.yml file:

    name: Lint PRs with Vale
    
    on: pull_request
    
    jobs:
      vale-lint-PR:
        runs-on: ubuntu-latest
        steps:
        - uses: actions/checkout@master
          with:
            fetch-depth: 1
        - uses: gaurav-nelson/github-action-vale-lint@v0.0.2-alpha
          env:
            GH_COMMENT_TOKEN: ${{ secrets.GH_COMMENT_TOKEN }}

Add Vale errors as comments on PR

If you want to show errors as comments on the pull request, in your repository:

  1. Go to Settings > Secrets, and slect Add a new secret.
  2. Enter GH_COMMENT_TOKEN for Name, and enter your secret token as
    Value.
  3. Select Add secret.