|
| 1 | +# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-toc-task.md |
| 2 | +name: Check ToC |
| 3 | + |
| 4 | +env: |
| 5 | + # See: https://github.com/actions/setup-node/#readme |
| 6 | + NODE_VERSION: 16.x |
| 7 | + |
| 8 | +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows |
| 9 | +on: |
| 10 | + create: |
| 11 | + push: |
| 12 | + paths: |
| 13 | + - ".github/workflows/check-toc-task.ya?ml" |
| 14 | + - "package.json" |
| 15 | + - "package-lock.json" |
| 16 | + - "README.md" |
| 17 | + pull_request: |
| 18 | + paths: |
| 19 | + - ".github/workflows/check-toc-task.ya?ml" |
| 20 | + - "package.json" |
| 21 | + - "package-lock.json" |
| 22 | + - "README.md" |
| 23 | + schedule: |
| 24 | + # Run periodically to catch breakage caused by external changes. |
| 25 | + - cron: "0 3 * * WED" |
| 26 | + workflow_dispatch: |
| 27 | + repository_dispatch: |
| 28 | + |
| 29 | +jobs: |
| 30 | + run-determination: |
| 31 | + runs-on: ubuntu-latest |
| 32 | + outputs: |
| 33 | + result: ${{ steps.determination.outputs.result }} |
| 34 | + steps: |
| 35 | + - name: Determine if the rest of the workflow should run |
| 36 | + id: determination |
| 37 | + run: | |
| 38 | + RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x" |
| 39 | + # The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead. |
| 40 | + if [[ |
| 41 | + "${{ github.event_name }}" != "create" || |
| 42 | + "${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX |
| 43 | + ]]; then |
| 44 | + # Run the other jobs. |
| 45 | + RESULT="true" |
| 46 | + else |
| 47 | + # There is no need to run the other jobs. |
| 48 | + RESULT="false" |
| 49 | + fi |
| 50 | +
|
| 51 | + echo "result=$RESULT" >> $GITHUB_OUTPUT |
| 52 | +
|
| 53 | + check: |
| 54 | + name: ${{ matrix.file.name }} |
| 55 | + needs: run-determination |
| 56 | + if: needs.run-determination.outputs.result == 'true' |
| 57 | + runs-on: ubuntu-latest |
| 58 | + |
| 59 | + strategy: |
| 60 | + fail-fast: false |
| 61 | + |
| 62 | + matrix: |
| 63 | + file: |
| 64 | + - name: README.md |
| 65 | + # Max ToC depth, for use with the markdown-toc --maxdepth flag. |
| 66 | + maxdepth: 5 |
| 67 | + |
| 68 | + steps: |
| 69 | + - name: Checkout repository |
| 70 | + uses: actions/checkout@v3 |
| 71 | + |
| 72 | + - name: Setup Node.js |
| 73 | + uses: actions/setup-node@v3 |
| 74 | + with: |
| 75 | + node-version: ${{ env.NODE_VERSION }} |
| 76 | + |
| 77 | + - name: Install Task |
| 78 | + uses: arduino/setup-task@v1 |
| 79 | + with: |
| 80 | + repo-token: ${{ secrets.GITHUB_TOKEN }} |
| 81 | + version: 3.x |
| 82 | + |
| 83 | + - name: Rebuild ToC |
| 84 | + run: | |
| 85 | + task markdown:toc \ |
| 86 | + FILE_PATH="${{ github.workspace }}/${{ matrix.file.name }}" \ |
| 87 | + MAX_DEPTH=${{ matrix.file.maxdepth }} |
| 88 | +
|
| 89 | + - name: Check ToC |
| 90 | + run: git diff --color --exit-code |
0 commit comments