Test: run use reviewdog on all linters #14
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: Add lint reviews to PRs | |
on: | |
pull_request: | |
branches: | |
- main | |
paths: | |
- .nvmrc | |
- "**/*.md" | |
jobs: | |
lint-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Get changed files | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
BASE_SHA: ${{ github.event.pull_request.base.sha }} | |
HEAD_SHA: ${{ github.event.pull_request.head.sha }} | |
run: | | |
# Use the GitHub API to get the list of changed files | |
# documenation: https://docs.github.com/rest/commits/commits#compare-two-commits | |
DIFF_DOCUMENTS=$(gh api repos/{owner}/{repo}/compare/${{ env.BASE_SHA }}...${{ env.HEAD_SHA }} \ | |
--jq '.files | .[] | select(.status|IN("added", "modified", "renamed", "copied", "changed")) | .filename') | |
# filter out files that are not markdown | |
DIFF_DOCUMENTS=$(echo "${DIFF_DOCUMENTS}" | egrep -i "^files/.*\.md$" | xargs) | |
echo "DIFF_DOCUMENTS=${DIFF_DOCUMENTS}" >> $GITHUB_ENV | |
- name: Setup Node.js environment | |
uses: actions/setup-node@v3 | |
with: | |
node-version-file: ".nvmrc" | |
cache: yarn | |
- name: Install all yarn packages | |
run: yarn --frozen-lockfile | |
env: | |
# https://github.com/microsoft/vscode-ripgrep#github-api-limit-note | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
- name: Lint markdown files | |
run: | | |
#echo "::add-matcher::.github/workflows/markdownlint-problem-matcher.json" | |
echo "Running markdownlint --fix" | |
files_to_lint="${{ env.DIFF_DOCUMENTS }}" | |
MD_LINT_STATUS=0 | |
MD_LINT_LOG=$(yarn markdownlint-cli2 --fix ${files_to_lint} 2>&1) || MD_LINT_STATUS=1 | |
echo "MD_LINT_LOG<<EOF" >> $GITHUB_ENV | |
echo "${MD_LINT_LOG}" >> $GITHUB_ENV | |
echo "EOF" >> $GITHUB_ENV | |
echo "MD_LINT_STATUS=${MD_LINT_STATUS}" >> $GITHUB_ENV | |
echo "Linting front-matter" | |
FM_LINT_STATUS=0 | |
FM_LINT_LOG=$(node scripts/front-matter_linter.js --fix true ${files_to_lint} 2>&1) || FM_LINT_STATUS=1 | |
echo "FM_LINT_LOG<<EOF" >> $GITHUB_ENV | |
echo "${FM_LINT_LOG}" >> $GITHUB_ENV | |
echo "EOF" >> $GITHUB_ENV | |
echo "FM_LINT_STATUS=${FM_LINT_STATUS}" >> $GITHUB_ENV | |
echo "Running Prettier" | |
yarn prettier -w ${files_to_lint} | |
- name: Setup reviewdog | |
uses: reviewdog/action-setup@v1 | |
with: | |
reviewdog_version: latest | |
- name: Suggest changes | |
env: | |
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
run: | | |
echo "$REVIEWDOG_GITHUB_API_TOKEN" | |
reviewdog -name="MDN-linter" -tee -f=diff -diff="git diff" -reporter="github-pr-review" | |
- name: Add reviews for markdonwlint errors | |
if: env.MD_LINT_STATUS != '1' | |
env: | |
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
run: | | |
echo "${{ env.MD_LINT_LOG }}" | \ | |
reviewdog \ | |
-tee \ | |
-efm="%f:%l:%c %m" \ | |
-efm="%f:%l %m" \ | |
-name="markdownlint" \ | |
-diff="git diff" \ | |
-reporter="github-pr-review" | |
- name: Log and fail if front-matter linter fails | |
if: env.FM_LINT_STATUS == '1' | |
run: | | |
echo "${{ env.FM_LINT_LOG }}" |