Validate markdown files - #74
Merged
Merged
Conversation
This was referenced Oct 20, 2023
Avantol13
previously approved these changes
Oct 23, 2023
| - name: Set up config files | ||
| run: | | ||
| wget https://raw.githubusercontent.com/uc-cdis/.github/feat/lint-md/.github/workflows/validate_markdown_lint.jsonc -P .github/workflows/ | ||
| wget https://raw.githubusercontent.com/uc-cdis/.github/feat/lint-md/.github/workflows/validate_markdown_links.json -P .github/workflows/ |
Contributor
There was a problem hiding this comment.
pulling these here and running the lint right after in this workflow means that repos don't have the option of overriding or modifyig the config. In this case that's probably fine, but like for Super Lint b/c there's so many linters and probably different repos may want diff standards at first, I was trying to build in some flexibility to override the defaults. All that said, for the markdown linting I'm happy forcing the global config
Collaborator
Author
There was a problem hiding this comment.
yes i didn't have time to add configuration on friday, and i thought it'd be fine to merge it as-is and add configuration later if needed. plus this way all the repos are consistent
Avantol13
approved these changes
Oct 23, 2023
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Complains about bad syntax (but we can disable rules we don't care about) and about dead links.
The config is centralized here so that we use consistent style across repos.
Uses https://github.com/marketplace/actions/markdown-linting-action and https://github.com/marketplace/actions/markdown-link-check
Surround a link with
<!-- markdown-link-check-disable -->and<!-- markdown-link-check-enable -->to skip link validationNew Features