CI: Validate headings #596
Open
Conversation
This file contains hidden or 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
✅ Deploy Preview for nextflow-training ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Looks great, thanks Phil! |
|
@ewels Would you mind adding a short note on usage (especially the --fix usage) in the repo readme? |
vdauwera
added
documentation
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.
New script + GitHub actions workflow to validate any markdown files that have been edited in a PR. Checks:
.### 1.2.and not# 1.2.)Can be run locally on all files, also has a
--fixparameter to automagically fix the markdown in-place.Sometimes it's not always super clear why errors are there, for example
02_hello_modules.mdhas:2.2.1.1.2.2.This throws an error:
And fix will do something a bit confusing like changing this to:
2.2.1.1.2.1.Also for heading re-numbering fixes, you often have to re-run the script a bunch of times as it goes through fixing subsequent headings.
So handle the diff with some care, probably not ready for a bot auto-fix workflow command yet 😅
Hopefully helpful though.