Skip to content

Commit 856521d

Browse files
authored
Merge pull request #4 from ralfhandl/improve-markdown-linting
Remove mdv from workflow
2 parents 9cc6be0 + d265168 commit 856521d

File tree

3 files changed

+686
-944
lines changed

3 files changed

+686
-944
lines changed

.github/workflows/validate-markdown.yaml

+7-8
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,15 @@ name: validate-markdown
44
# Issue: https://github.com/OAI/OpenAPI-Specification/issues/2130
55

66
#
7-
# This workflow validates files in the versions directory matching 3.*.md
8-
# Versions before 3.0 are not validated, as they contain linking errors
9-
# where it is not currently planned to go back and fix them
7+
# This workflow validates markdown files in the project root.
8+
# It also validates the work-in-progress specification file src/oas.md with slightly different rules.
109
#
1110

1211
# run this on push to any branch and creation of pull-requests
1312
on: [push, pull_request]
1413

1514
jobs:
16-
mdv:
15+
lint:
1716

1817
runs-on: ubuntu-latest
1918

@@ -27,8 +26,8 @@ jobs:
2726
with:
2827
node-version: '20.x'
2928

30-
- name: Validate markdown
31-
run: npx --yes mdv versions/3.*.md src/oas.md
29+
- name: Lint work-in-progress spec
30+
run: npx --yes markdownlint-cli2 --config spec.markdownlint.yaml src/oas.md
3231

33-
- name: Lint markdown 3.0.4, 3.1.1, and later
34-
run: npx --yes markdownlint-cli --config .markdownlint.yaml versions/3.0.4.md versions/3.1.[^0].md versions/3.[2-9].*.md src/oas.md
32+
- name: Lint other files
33+
run: npx --yes markdownlint-cli2 *.md

0 commit comments

Comments
 (0)