Release version 0.0.3
Pre-release
Pre-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.
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
-
Create a new file in your repository
.github/workflows/action.yml
.touch .github/workflows/action.yml
-
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:
- Go to Settings > Secrets, and slect Add a new secret.
- Enter GH_COMMENT_TOKEN for Name, and enter your secret token as
Value. - Select Add secret.