Add CI workflow to check Markdown files for problems #131
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
MatteoPologruto
added
type: enhancement
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 file. In the event the repository contains externally maintained Markdown files, markdownlint can be configured to ignore them via a file: https://github.com/igorshubovych/markdownlint-cli#ignoring-files markdown-link-check is configured via the file: https://github.com/tcort/markdown-link-check#config-file-format
MatteoPologruto
force-pushed
the
check-markdown
branch
from
e515ef9 to
c64fca7
Compare
cmaglie
approved these changes
Aug 4, 2022
umbynos
approved these changes
Aug 4, 2022
MatteoPologruto
changed the title
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.
Please check if the PR fulfills these requirements
before creating one)
Infrastructure enhancement
Markdown files are not being checked.
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.ymlfile.In the event the repository contains externally maintained Markdown files, markdownlint can be configured to ignore them via a
.markdownlintignorefile:https://github.com/igorshubovych/markdownlint-cli#ignoring-files
markdown-link-check is configured via the
.markdown-link-check.jsonfile:https://github.com/tcort/markdown-link-check#config-file-format
The task
docs:generatehas been emptied because it was depending ongo:cli-docsandprotoc:docs, which led to error messages when runningtask markdown:check-links.