Loading files
This file is pinned to the selected release. Download the original to open it in your design tool.
b3809a466This file is pinned to the selected release. Download the original to open it in your design tool.
name: Lint Markdown Docs
on:
pull_request:
paths:
- '**/*.md'
- '.markdownlint-cli2.yaml'
- 'firmware/package.json'
- 'firmware/package-lock.json'
- 'firmware/scripts/lint-docs-changed.sh'
- '.github/workflows/docs-lint.yml'
push:
branches:
- dev/v1.0
paths:
- '**/*.md'
- '.markdownlint-cli2.yaml'
- 'firmware/package.json'
- 'firmware/package-lock.json'
- 'firmware/scripts/lint-docs-changed.sh'
- '.github/workflows/docs-lint.yml'
jobs:
markdown-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 22
- name: Install dependencies
run: npm ci
working-directory: ./firmware
- name: Lint changed markdown files (pull request)
if: github.event_name == 'pull_request'
env:
DOC_LINT_BASE: origin/${{ github.base_ref }}
run: npm run docs:lint:changed
working-directory: ./firmware
- name: Lint changed markdown files (push)
if: github.event_name == 'push'
env:
DOC_LINT_BASE: ${{ github.event.before }}
run: npm run docs:lint:changed
working-directory: ./firmware