Add env descriptions to docs #16
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 docs with Vale linter | |
on: | |
pull_request: | |
types: [opened, synchronize] | |
jobs: | |
vale: | |
name: Vale linter | |
runs-on: ubuntu-latest | |
steps: | |
- name: check out repo | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 2 | |
- name: get changed files | |
id: changed-files | |
uses: tj-actions/changed-files@v39 | |
with: | |
fetch_depth: 2 | |
# run reviewdog and the linter | |
- name: run reviewdog and linter | |
uses: errata-ai/vale-action@reviewdog | |
with: | |
files: ${{ steps.changed-files.outputs.all_changed_and_modified_files }} | |
separator: "," | |
# added, diff_context, file, nofilter | |
filter_mode: nofilter | |
# github-pr-check, github-pr-review, github-check | |
reporter: github-pr-check | |
fail_on_error: false | |
env: | |
# Required, set by GitHub actions automatically: | |
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret | |
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |