Update description #38
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
# Workflow file for running markdownlint | |
# https://github.com/DavidAnson/markdownlint | |
name: markdownlint | |
env: | |
NODE_VERSION: 20 | |
on: | |
push: | |
branches: | |
- master | |
paths: | |
- "**.md" | |
- ".markdownlint.json" | |
- ".markdownlintignore" | |
- "package.json" | |
- "pnpm-lock.yaml" | |
pull_request: | |
branches: | |
- master | |
paths: | |
- "**.md" | |
- ".markdownlint.json" | |
- ".markdownlintignore" | |
- "package.json" | |
- "pnpm-lock.yaml" | |
jobs: | |
markdownlint: | |
name: Run markdownlint | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out to repository | |
uses: actions/checkout@v4 | |
- name: Install pnpm | |
uses: pnpm/action-setup@v4 | |
- name: Set up Node.js | |
uses: actions/setup-node@v4 | |
with: | |
node-version: ${{ env.NODE_VERSION }} | |
cache: pnpm | |
- name: Install dependencies | |
run: pnpm install | |
# If the linter found any errors, it will exit with a non-zero code, which will cause the job to fail | |
- name: Run markdownlint | |
run: pnpm lint:md |