Add vale linting in github pipeline #2
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Check Docusaurus docs with Vale linter | |
| on: [pull_request] | |
| jobs: | |
| vale: | |
| name: Vale doc linter | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/[email protected] | |
| # Set up Vale Action | |
| - uses: errata-ai/[email protected] | |
| with: | |
| # Filter mode can be set to: added, diff_context, file, nofilter | |
| filter_mode: nofilter | |
| # Set the reporter to display the output: github-pr-check, github-pr-review, github-check | |
| reporter: github-pr-check | |
| # Fails the action if there are errors | |
| fail_on_error: true | |
| # Lint the files in the "versioned_docs/version-2.0.0/" directory | |
| files: 'versioned_docs/version-2.0.0/**/*.md' | |
| # Specify the Vale version | |
| version: 3.0.3 | |
| env: | |
| # GitHub token for authentication, automatically set by GitHub Actions | |
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |