Lint Markdown files #88
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: Lint Markdown files | |
| on: | |
| push: | |
| branches: ["main"] | |
| paths: | |
| - "**/*.md" | |
| - ".github/workflows/lint-markdown.yml" | |
| pull_request: | |
| branches: ["main"] | |
| paths: | |
| - "**/*.md" | |
| - ".github/workflows/lint-markdown.yml" | |
| schedule: | |
| - cron: "44 7 * * 2" | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| pull-requests: read | |
| jobs: | |
| lint: | |
| name: Lint Markdown | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Lint Markdown | |
| uses: DavidAnson/markdownlint-cli2-action@v16 | |
| with: | |
| globs: "**/*.md" | |
| config: "maa-cli/docs/.markdownlint.yaml" | |
| check-links: | |
| name: Check Dead Links | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Check Dead Link | |
| uses: umbrelladocs/action-linkspector@v1 | |
| with: | |
| reporter: github-check | |
| # Check only the diff when triggered by a push or pull request; otherwise, check all files | |
| filter_mode: ${{ contains(fromJSON('["push", "pull_request"]'), github.event_name) && 'diff_context' || 'nofilter' }} | |
| fail_on_error: true |