Skip to content

Validate markdown before source build#4307

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.

Sign up for GitHub

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

Closed
handrews wants to merge 1 commit into from
Closed

Validate markdown before source build #4307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line numberDiff line numberDiff 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`
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

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: 2 additions & 0 deletions scripts/md2html/build-src.sh
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,8 @@

# run this script from the root of the repo

npm run validate-markdown || exit -1

@ralfhandlralfhandlJan 17, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think of npm scripts as a layer on top of bash or JS scripts and would rather extend the build-src script in package.json to

"build-src": "npm run validate && bash bash ./scripts/md2html/build-src.sh",

@handrewshandrewsJan 18, 2025

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@handrews that works for me, although I think you only want one bash... or is there also supposed to be a bash before npm run validate? Either way I'll take this down and either you or I can post a PR with this approach.


mkdir -p deploy-preview/temp
mkdir -p deploy-preview/js

Expand Down