Lint Markdown files after push by mhucka #106
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
# @file markdown-linter.yml | |
# @brief GitHub Actions workflow to run a Markdown linter on .md files | |
# @license Please see the file named LICENSE in the repository | |
# @repo https://github.com/AI4LAM/awesome-ai4lam | |
name: Markdown file linter | |
run-name: Lint Markdown files after ${{github.event_name}} by ${{github.actor}} | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- '*.md' | |
pull_request: | |
branches: | |
- main | |
paths: | |
- '*.md' | |
workflow_dispatch: | |
paths: | |
- '*.md' | |
jobs: | |
lint: | |
name: Run Markdown linter | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out copy of git repository. | |
uses: actions/checkout@v4 | |
- name: Run Markdownlint on .md files. | |
uses: DavidAnson/markdownlint-cli2-action@v15 | |
with: | |
config: .markdownlint.json | |
globs: | | |
*.md |