83 lines
2.0 KiB
YAML
83 lines
2.0 KiB
YAML
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-markdown-task.md
|
|
name: Check Markdown
|
|
|
|
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows
|
|
on:
|
|
push:
|
|
paths:
|
|
- ".github/workflows/check-markdown-task.ya?ml"
|
|
- ".markdown-link-check.json"
|
|
- ".npmrc"
|
|
- "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"
|
|
- ".npmrc"
|
|
- "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:
|
|
lint:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v5
|
|
|
|
- name: Setup Node.js
|
|
uses: actions/setup-node@v5
|
|
with:
|
|
node-version-file: package.json
|
|
|
|
- name: Initialize markdownlint-cli problem matcher
|
|
uses: xt0rted/markdownlint-problem-matcher@v3
|
|
|
|
- name: Install Task
|
|
uses: go-task/setup-task@v1
|
|
with:
|
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
version: 3.x
|
|
|
|
- name: Lint
|
|
run: task markdown:lint
|
|
|
|
links:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v5
|
|
|
|
- name: Setup Node.js
|
|
uses: actions/setup-node@v5
|
|
with:
|
|
node-version-file: package.json
|
|
|
|
- name: Install Task
|
|
uses: go-task/setup-task@v1
|
|
with:
|
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
version: 3.x
|
|
|
|
- name: Check links
|
|
run: task --silent markdown:check-links
|