Closed MatteoPologruto closed 2 years ago
Please check if the PR fulfills these requirements
[x] The PR has no duplicates (please search among the Pull Requests before creating one)
[x] The PR follows our contributing guidelines
[x] Tests for the changes have been added (for bug fixes / features)
What kind of change does this PR introduce?
Infrastructure enhancement
What is the current behavior?
Markdown files are not being checked.
What is the new behavior?
On every push and pull request that affects relevant files, and periodically, check the repository's Markdown files for problems:
Use markdownlint-cli 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.
.markdownlint.yml
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
.markdownlintignore
markdown-link-check is configured via the .markdown-link-check.json file: https://github.com/tcort/markdown-link-check#config-file-format
.markdown-link-check.json
The task docs:generate has been emptied because it was depending on go:cli-docs and protoc:docs, which led to error messages when running task markdown:check-links.
docs:generate
go:cli-docs
protoc:docs
task markdown:check-links
Please check if the PR fulfills these requirements
[x] The PR has no duplicates (please search among the Pull Requests before creating one)
[x] The PR follows our contributing guidelines
[x] Tests for the changes have been added (for bug fixes / features)
What kind of change does this PR introduce?
Infrastructure enhancement
What is the current behavior?
Markdown files are not being checked.
What is the new behavior?
On every push and pull request that affects relevant files, and periodically, check the repository's Markdown files for problems:
Use markdownlint-cli 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.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-filesmarkdown-link-check is configured via the
.markdown-link-check.jsonfile: https://github.com/tcort/markdown-link-check#config-file-formatThe task
docs:generatehas been emptied because it was depending ongo:cli-docsandprotoc:docs, which led to error messages when runningtask markdown:check-links.