Validate markdown before source build #4307
Closed
Conversation
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
ralfhandl
reviewed
Jan 17, 2025
| @@ -4,6 +4,8 @@ | |||
|
|
|||
| # run this script from the root of the repo | |||
|
|
|||
| npm run validate-markdown || exit -1 | |||
There was a problem hiding this comment.
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",
There was a problem hiding this comment.
@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.
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
idk about y'all but the chances of me remembering to run two commands instead of one is a lot smaller than the chances of me remembering to do one.
Let's have the src (but not production!) build run markdown validation as a pre-check. Any reason not to?