Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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
per1234 merged 2 commits into arduino:main from per1234:check-md
Jul 29, 2021
Merged

Add CI workflow to check Markdown files for problems #216

per1234 merged 2 commits into arduino:main from per1234:check-md
Jul 29, 2021

Conversation

Copy link
Contributor

@per1234 per1234 commented Jul 29, 2021

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 added 2 commits July 28, 2021 20:19
`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
Copy link

Codecov Report

Merging #216 (77e2593) into main (bee41c0) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@ Coverage Diff @@
## main #216 +/- ##
=======================================
 Coverage 87.97% 87.97% 
=======================================
 Files 43 43 
 Lines 4176 4176 
=======================================
 Hits 3674 3674 
 Misses 391 391 
 Partials 111 111 
Flag Coverage Δ
unit 87.97% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bee41c0...77e2593. Read the comment docs.

@per1234 per1234 merged commit 29684f4 into arduino:main Jul 29, 2021
@per1234 per1234 deleted the check-md branch August 1, 2021 18:07
@per1234 per1234 self-assigned this Nov 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@silvanocerza silvanocerza Awaiting requested review from silvanocerza

1 more reviewer

@umbynos umbynos umbynos approved these changes

Reviewers whose approvals may not affect merge requirements
Labels
topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /