Check Markdown #575
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
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-markdown-task.md | |
| name: Check Markdown | |
| env: | |
| # See: https://github.com/actions/setup-node/#readme | |
| NODE_VERSION: 16.x | |
| # See: https://github.com/actions/setup-go/tree/main#supported-version-syntax | |
| GO_VERSION: "1.20" | |
| # See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows | |
| on: | |
| create: | |
| push: | |
| paths: | |
| - ".github/workflows/check-markdown-task.ya?ml" | |
| - ".markdown-link-check.json" | |
| - "package.json" | |
| - "package-lock.json" | |
| - "Taskfile.ya?ml" | |
| - "**/.markdownlint*" | |
| - "**.go" | |
| - "**.mdx?" | |
| - "**.mkdn" | |
| - "**.mdown" | |
| - "**.markdown" | |
| - "rpc/**" | |
| pull_request: | |
| paths: | |
| - ".github/workflows/check-markdown-task.ya?ml" | |
| - ".markdown-link-check.json" | |
| - "package.json" | |
| - "package-lock.json" | |
| - "Taskfile.ya?ml" | |
| - "**/.markdownlint*" | |
| - "**.go" | |
| - "**.mdx?" | |
| - "**.mkdn" | |
| - "**.mdown" | |
| - "**.markdown" | |
| - "rpc/**" | |
| schedule: | |
| # Run every Tuesday at 8 AM UTC to catch breakage caused by external changes. | |
| - cron: "0 8 * * TUE" | |
| workflow_dispatch: | |
| repository_dispatch: | |
| jobs: | |
| run-determination: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| result: ${{ steps.determination.outputs.result }} | |
| steps: | |
| - name: Determine if the rest of the workflow should run | |
| id: determination | |
| run: | | |
| RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x" | |
| # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead. | |
| if [[ | |
| "${{ github.event_name }}" != "create" || | |
| "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX | |
| ]]; then | |
| # Run the other jobs. | |
| RESULT="true" | |
| else | |
| # There is no need to run the other jobs. | |
| RESULT="false" | |
| fi | |
| echo "result=$RESULT" >> $GITHUB_OUTPUT | |
| lint: | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: Initialize markdownlint-cli problem matcher | |
| uses: xt0rted/markdownlint-problem-matcher@v2 | |
| - name: Install Task | |
| uses: arduino/setup-task@v1 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Lint | |
| run: task markdown:lint | |
| links: | |
| needs: run-determination | |
| if: needs.run-determination.outputs.result == 'true' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Setup Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| - name: Install Go | |
| uses: actions/setup-go@v4 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Install Go dependencies | |
| run: go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@v1.4.1 | |
| - name: Install protoc compiler | |
| uses: arduino/setup-protoc@v1 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Install Task | |
| uses: arduino/setup-task@v1 | |
| with: | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| version: 3.x | |
| - name: Check links | |
| run: task --silent markdown:check-links |