Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add infrastructure to check Markdown files for problems
Several tasks and a GitHub Actions workflow are added to check for problems in the project's Markdown files. On every push and pull request that affects relevant files, and periodically, the GitHub Actions workflow runs the tasks to check the repository's Markdown files for problems: - Use markdownlint to check for common problems and formatting. - Use markdown-link-check to check for broken links. The Arduino tooling Markdown style is defined by the `.markdownlint.yml` file. In the event the repository contains externally maintained Markdown files, markdownlint can be configured to ignore them via a `.markdownlintignore` file: https://github.com/igorshubovych/markdownlint-cli#ignoring-files markdown-link-check is configured via the `.markdown-link-check.json` file: https://github.com/tcort/markdown-link-check#config-file-format
- Loading branch information
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-markdown-task.md | ||
| name: Check Markdown | ||
|
|
||
| # 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*" | ||
| - "**.mdx?" | ||
| - "**.mkdn" | ||
| - "**.mdown" | ||
| - "**.markdown" | ||
| pull_request: | ||
| paths: | ||
| - ".github/workflows/check-markdown-task.ya?ml" | ||
| - ".markdown-link-check.json" | ||
| - "package.json" | ||
| - "package-lock.json" | ||
| - "Taskfile.ya?ml" | ||
| - "**/.markdownlint*" | ||
| - "**.mdx?" | ||
| - "**.mkdn" | ||
| - "**.mdown" | ||
| - "**.markdown" | ||
| 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 | ||
| permissions: {} | ||
| 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 | ||
| permissions: | ||
| contents: read | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version-file: package.json | ||
|
|
||
| - 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 | ||
| permissions: | ||
| contents: read | ||
|
|
||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version-file: package.json | ||
|
|
||
| - 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 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "httpHeaders": [ | ||
| { | ||
| "urls": ["https://docs.github.com/"], | ||
| "headers": { | ||
| "Accept-Encoding": "gzip, deflate, br" | ||
| } | ||
| } | ||
| ], | ||
| "retryOn429": true, | ||
| "retryCount": 3, | ||
| "aliveStatusCodes": [200, 206] | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown/.markdownlint.yml | ||
| # See: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md | ||
| # The code style defined in this file is the official standardized style to be used in all Arduino projects and should | ||
| # not be modified. | ||
| # Note: Rules disabled solely because they are redundant to Prettier are marked with a "Prettier" comment. | ||
|
|
||
| default: false | ||
| MD001: false | ||
| MD002: false | ||
| MD003: false # Prettier | ||
| MD004: false # Prettier | ||
| MD005: false # Prettier | ||
| MD006: false # Prettier | ||
| MD007: false # Prettier | ||
| MD008: false # Prettier | ||
| MD009: | ||
| br_spaces: 0 | ||
| strict: true | ||
| list_item_empty_lines: false # Prettier | ||
| MD010: false # Prettier | ||
| MD011: true | ||
| MD012: false # Prettier | ||
| MD013: false | ||
| MD014: false | ||
| MD018: true | ||
| MD019: false # Prettier | ||
| MD020: true | ||
| MD021: false # Prettier | ||
| MD022: false # Prettier | ||
| MD023: false # Prettier | ||
| MD024: false | ||
| MD025: | ||
| level: 1 | ||
| front_matter_title: '^\s*"?title"?\s*[:=]' | ||
| MD026: false | ||
| MD027: false # Prettier | ||
| MD028: false | ||
| MD029: | ||
| style: one | ||
| MD030: | ||
| ul_single: 1 | ||
| ol_single: 1 | ||
| ul_multi: 1 | ||
| ol_multi: 1 | ||
| MD031: false # Prettier | ||
| MD032: false # Prettier | ||
| MD033: false | ||
| MD034: false | ||
| MD035: false # Prettier | ||
| MD036: false | ||
| MD037: true | ||
| MD038: true | ||
| MD039: true | ||
| MD040: false | ||
| MD041: false | ||
| MD042: true | ||
| MD043: false | ||
| MD044: false | ||
| MD045: true | ||
| MD046: | ||
| style: fenced | ||
| MD047: false # Prettier | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown/.markdownlintignore | ||
| .licenses/ | ||
| __pycache__/ | ||
| node_modules/ |
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
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
Oops, something went wrong.