0.1.0

• You can now lint for all files instead of all modified files.
• You can now select a specify directory to only lint files inside that directory.

Release version 0.0.3

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.

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

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.

Release version 0.0.2

1. Migrated to new YML format for GitHub Actions
2. Added option to comment Vale errors on PRs

Release version 0.0.1-alpha

Github action: Lint with Vale ✅❎

Automatically lint all modified text files in your GitHub pull requests. This GitHub action uses Vale to lint prose.

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

• Markdown *.md
• AsciiDoc *.adoc
• ReStructuredText *.rst

Prerequisite

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

Workflow action

workflow "Lint with vale on PR" {
  on = "pull_request"
  resolves = ["vale-lint-PR"]
}

action "vale-lint-PR" {
  uses = "./"
}

Upcoming

• Add all errors as a GitHub comment on PR.
• Vale version selector