Merge pull request #4040 from ralfhandl/v3.0.4-dev-markdownlint #1901
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: validate-markdown | |
# Author: @MikeRalphson | |
# Issue: https://github.com/OAI/OpenAPI-Specification/issues/2130 | |
# | |
# This workflow validates files in the versions directory matching 3.*.md | |
# Versions before 3.0 are not validated, as they contain linking errors | |
# where it is not currently planned to go back and fix them | |
# | |
# run this on push to any branch and creation of pull-requests | |
on: [push, pull_request] | |
jobs: | |
mdv: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 # checkout repo content | |
with: | |
fetch-depth: 0 | |
- name: use the javascript environment from main | |
run: | | |
git checkout remotes/origin/main -- package.json package-lock.json .markdownlint.yaml | |
- uses: actions/setup-node@v4 # setup Node.js | |
with: | |
node-version: '20.x' | |
- name: Validate markdown | |
run: npx --yes mdv versions/3.*.md | |
- name: Lint markdown v3.0.4 | |
run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/3.0.4.md | |