-
-
Notifications
You must be signed in to change notification settings - Fork 12
Add CI workflow to check Markdown files for problems #216
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
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
`npx --call` uses the native shell. This means the shell code used by the task does not work on Windows. After quite a bit of unsuccessful efforts, I decided that it is simply too difficult to use npx for this application on Windows. So the Windows user is required to have markdown-link-check installed and in PATH. Because Task uses an integrated shell interpreter, shell code is usable as long as it is not wrapped in a `npx --call` command.
On every push and pull request that affects relevant files, and periodically, check the repository's Markdown files for problems: - Use markdownlint to check for common problems and formatting. - Use markdown-link-check to check for broken links. The Arduino tooling Markdown style is defined by the `.markdownlint.yml` file. In the event the repository contains externally maintained Markdown files, markdownlint can be configured to ignore them via a `.markdownlintignore` file: https://github.com/igorshubovych/markdownlint-cli#ignoring-files markdown-link-check is configured via the `.markdown-link-check.json` file: https://github.com/tcort/markdown-link-check#config-file-format This duplicates the link check capability previously provided by the "Check links" workflow, so that has been removed.
@per1234
per1234
added
type: enhancement
Proposed improvement
topic: infrastructure
Related to project infrastructure
labels
Jul 29, 2021
codecov-commenter
commented
Jul 29, 2021
Codecov Report
@@ Coverage Diff @@ ## main #216 +/- ## ======================================= Coverage 87.97% 87.97% ======================================= Files 43 43 Lines 4176 4176 ======================================= Hits 3674 3674 Misses 391 391 Partials 111 111
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
umbynos
umbynos
approved these changes
Jul 29, 2021
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.
On every push and pull request that affects relevant files, and periodically, check the repository's Markdown files for
problems:
The Arduino tooling Markdown style is defined by the
.markdownlint.yml
file.In the event the repository contains externally maintained Markdown files, markdownlint can be configured to ignore them
via a
.markdownlintignore
file:https://github.com/igorshubovych/markdownlint-cli#ignoring-files
markdown-link-check is configured via the
.markdown-link-check.json
file:https://github.com/tcort/markdown-link-check#config-file-format
This duplicates the link check capability previously provided by the "Check links" workflow, so that has been removed.