Add rudimentary docs for compliance check pipeline #581
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: Markdownlint on PR | |
| 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: npm | |
| cache-dependency-path: package-lock.json | |
| - name: Install all npm packages | |
| run: npm install | |
| - name: Lint markdown files | |
| run: | | |
| npm run lint:md $DIFF_DOCUMENTS |