Skip to content

dev: validate markdown in build-src #4311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,12 +171,10 @@ To do this locally, please
1. Install [Node.js](https://nodejs.org/)
2. Check out this repo, go to the repo root, and switch to a development branch
3. Execute `npm install` (once, repeat after merging upstream changes)
4. Execute `npm run build-src` after changing `src/oas.md`
5. Open output file `deploy-preview/oas.html` with a browser
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
5. Open output file `deploy-preview/oas.html` with a browser and check your changes

Before creating a pull request or marking a draft pull request as ready for review, please

6. Execute `npm run validate-markdown` and fix any reported problems in `src/oas.md`
Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.

## Reviewers

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"license": "Apache-2.0",
"scripts": {
"build": "bash ./scripts/md2html/build.sh",
"build-src": "bash ./scripts/md2html/build-src.sh",
"build-src": "npm run validate-markdown && bash ./scripts/md2html/build-src.sh",
"test": "c8 --100 vitest --watch=false && bash scripts/schema-test-coverage.sh",
"validate-markdown": "npx mdv src/oas.md && npx markdownlint-cli src/oas.md"
},
Expand Down
Loading