Skip to content

Commit a20ab99

Browse files
MatteoPologrutoMatteoPologruto
authored
Add CI workflow to check Markdown files for problems (#9)
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
1 parent 7bf4782 commit a20ab99

File tree

9 files changed

+1384
-1
lines changed

9 files changed

+1384
-1
lines changed

‎.github/check-markdown-task.yml

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-markdown-task.md
2+
name: Check Markdown
3+
4+
env:
5+
# See: https://github.com/actions/setup-node/#readme
6+
NODE_VERSION: 16.x
7+
8+
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
9+
on:
10+
create:
11+
push:
12+
paths:
13+
- ".github/workflows/check-markdown-task.ya?ml"
14+
- ".markdown-link-check.json"
15+
- "package.json"
16+
- "package-lock.json"
17+
- "Taskfile.ya?ml"
18+
- "**/.markdownlint*"
19+
- "**.mdx?"
20+
- "**.mkdn"
21+
- "**.mdown"
22+
- "**.markdown"
23+
pull_request:
24+
paths:
25+
- ".github/workflows/check-markdown-task.ya?ml"
26+
- ".markdown-link-check.json"
27+
- "package.json"
28+
- "package-lock.json"
29+
- "Taskfile.ya?ml"
30+
- "**/.markdownlint*"
31+
- "**.mdx?"
32+
- "**.mkdn"
33+
- "**.mdown"
34+
- "**.markdown"
35+
schedule:
36+
# Run every Tuesday at 8 AM UTC to catch breakage caused by external changes.
37+
- cron: "0 8 * * TUE"
38+
workflow_dispatch:
39+
repository_dispatch:
40+
41+
jobs:
42+
run-determination:
43+
runs-on: ubuntu-latest
44+
permissions: {}
45+
outputs:
46+
result: ${{ steps.determination.outputs.result }}
47+
steps:
48+
- name: Determine if the rest of the workflow should run
49+
id: determination
50+
run: |
51+
RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
52+
# The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
53+
if [[
54+
"${{ github.event_name }}" != "create" ||
55+
"${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX
56+
]]; then
57+
# Run the other jobs.
58+
RESULT="true"
59+
else
60+
# There is no need to run the other jobs.
61+
RESULT="false"
62+
fi
63+
64+
echo "result=$RESULT" >> $GITHUB_OUTPUT
65+
66+
lint:
67+
needs: run-determination
68+
if: needs.run-determination.outputs.result == 'true'
69+
runs-on: ubuntu-latest
70+
permissions:
71+
contents: read
72+
73+
steps:
74+
- name: Checkout repository
75+
uses: actions/checkout@v3
76+
77+
- name: Setup Node.js
78+
uses: actions/setup-node@v3
79+
with:
80+
node-version: ${{ env.NODE_VERSION }}
81+
82+
- name: Initialize markdownlint-cli problem matcher
83+
uses: xt0rted/markdownlint-problem-matcher@v2
84+
85+
- name: Install Task
86+
uses: arduino/setup-task@v1
87+
with:
88+
repo-token: ${{ secrets.GITHUB_TOKEN }}
89+
version: 3.x
90+
91+
- name: Lint
92+
run: task markdown:lint
93+
94+
links:
95+
needs: run-determination
96+
if: needs.run-determination.outputs.result == 'true'
97+
runs-on: ubuntu-latest
98+
permissions:
99+
contents: read
100+
101+
steps:
102+
- name: Checkout repository
103+
uses: actions/checkout@v3
104+
105+
- name: Setup Node.js
106+
uses: actions/setup-node@v3
107+
with:
108+
node-version: ${{ env.NODE_VERSION }}
109+
110+
- name: Install Task
111+
uses: arduino/setup-task@v1
112+
with:
113+
repo-token: ${{ secrets.GITHUB_TOKEN }}
114+
version: 3.x
115+
116+
- name: Check links
117+
run: task --silent markdown:check-links

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,5 @@ sketches/commands/build/arduino.renesas_uno.unor4wifi/commands.ino.elf
3232
sketches/commands/build/arduino.renesas_uno.unor4wifi/commands.ino.hex
3333
sketches/commands/build/arduino.renesas_uno.unor4wifi/commands.ino.map
3434
/dist
35+
36+
/node_modules/

‎.markdown-link-check.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"httpHeaders": [
3+
{
4+
"urls": ["https://docs.github.com/"],
5+
"headers": {
6+
"Accept-Encoding": "gzip, deflate, br"
7+
}
8+
}
9+
],
10+
"retryOn429": true,
11+
"retryCount": 3,
12+
"aliveStatusCodes": [200, 206]
13+
}

‎.markdownlint.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown/.markdownlint.yml
2+
# See: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
3+
# The code style defined in this file is the official standardized style to be used in all Arduino projects and should
4+
# not be modified.
5+
# Note: Rules disabled solely because they are redundant to Prettier are marked with a "Prettier" comment.
6+
7+
default: false
8+
MD001: false
9+
MD002: false
10+
MD003: false # Prettier
11+
MD004: false # Prettier
12+
MD005: false # Prettier
13+
MD006: false # Prettier
14+
MD007: false # Prettier
15+
MD008: false # Prettier
16+
MD009:
17+
br_spaces: 0
18+
strict: true
19+
list_item_empty_lines: false # Prettier
20+
MD010: false # Prettier
21+
MD011: true
22+
MD012: false # Prettier
23+
MD013: false
24+
MD014: false
25+
MD018: true
26+
MD019: false # Prettier
27+
MD020: true
28+
MD021: false # Prettier
29+
MD022: false # Prettier
30+
MD023: false # Prettier
31+
MD024: false
32+
MD025:
33+
level: 1
34+
front_matter_title: '^\s*"?title"?\s*[:=]'
35+
MD026: false
36+
MD027: false # Prettier
37+
MD028: false
38+
MD029:
39+
style: one
40+
MD030:
41+
ul_single: 1
42+
ol_single: 1
43+
ul_multi: 1
44+
ol_multi: 1
45+
MD031: false # Prettier
46+
MD032: false # Prettier
47+
MD033: false
48+
MD034: false
49+
MD035: false # Prettier
50+
MD036: false
51+
MD037: true
52+
MD038: true
53+
MD039: true
54+
MD040: false
55+
MD041: false
56+
MD042: true
57+
MD043: false
58+
MD044: false
59+
MD045: true
60+
MD046:
61+
style: fenced
62+
MD047: false # Prettier

‎.markdownlintignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown/.markdownlintignore
2+
.licenses/
3+
__pycache__/
4+
node_modules/

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# uno-r4-wifi-fwuploader-plugin
2+
23
[![Release status](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/release-go-task.yml/badge.svg)](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/release-go-task.yml)
34

45
[![Check Go Dependencies status](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/check-go-dependencies-task.yml/badge.svg)](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/check-go-dependencies-task.yml)
56
[![Check Go status](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/check-go-task.yml/badge.svg)](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/check-go-task.yml)
67
[![Sync Labels status](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/sync-labels.yml/badge.svg)](https://github.com/arduino/fwuploader-plugin-helper/actions/workflows/sync-labels.yml)
78
[![Test Go status](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/test-go-task.yml/badge.svg)](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/test-go-task.yml)
9+
[![Check Markdown status](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/check-markdown-task.yml/badge.svg)](https://github.com/arduino/uno-r4-wifi-fwuploader-plugin/actions/workflows/check-markdown-task.yml)
810
[![Codecov](https://codecov.io/gh/arduino/uno-r4-wifi-fwuploader-plugin/branch/main/graph/badge.svg)](https://codecov.io/gh/arduino/uno-r4-wifi-fwuploader-plugin)
911

1012
Be sure to have `libudev-dev` installed

‎Taskfile.yml

Lines changed: 86 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ tasks:
1818
- task: config:check
1919
- task: general:check-formatting
2020

21+
docs:generate:
22+
desc: Create all generated documentation content
23+
# This is an "umbrella" task used to call any documentation generation processes the project has.
24+
# It can be left empty if there are none.
25+
2126
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-dependencies-task/Taskfile.yml
2227
general:cache-dep-licenses:
2328
desc: Cache dependency license metadata
@@ -114,6 +119,87 @@ tasks:
114119
cmds:
115120
- go vet {{default .DEFAULT_GO_PACKAGES .GO_PACKAGES}}
116121

122+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
123+
markdown:check-links:
124+
desc: Check for broken links
125+
deps:
126+
- task: docs:generate
127+
- task: npm:install-deps
128+
cmds:
129+
- |
130+
if [[ "{{.OS}}" == "Windows_NT" ]]; then
131+
# npx --call uses the native shell, which makes it too difficult to use npx for this application on Windows,
132+
# so the Windows user is required to have markdown-link-check installed and in PATH.
133+
if ! which markdown-link-check &>/dev/null; then
134+
echo "markdown-link-check not found or not in PATH."
135+
echo "Please install: https://github.com/tcort/markdown-link-check#readme"
136+
exit 1
137+
fi
138+
# Default behavior of the task on Windows is to exit the task when the first broken link causes a non-zero
139+
# exit status, but it's better to check all links before exiting.
140+
set +o errexit
141+
STATUS=0
142+
# Using -regex instead of -name to avoid Task's behavior of globbing even when quoted on Windows
143+
# The odd method for escaping . in the regex is required for windows compatibility because mvdan.cc/sh gives
144+
# \ characters special treatment on Windows in an attempt to support them as path separators.
145+
for file in $(
146+
find . \
147+
-type d -name '.git' -prune -o \
148+
-type d -name '.licenses' -prune -o \
149+
-type d -name '__pycache__' -prune -o \
150+
-type d -name 'node_modules' -prune -o \
151+
-regex ".*[.]md" -print
152+
); do
153+
markdown-link-check \
154+
--quiet \
155+
--config "./.markdown-link-check.json" \
156+
"$file"
157+
STATUS=$(( $STATUS + $? ))
158+
done
159+
exit $STATUS
160+
else
161+
npx --package=markdown-link-check --call='
162+
STATUS=0
163+
for file in $(
164+
find . \
165+
-type d -name '.git' -prune -o \
166+
-type d -name '.licenses' -prune -o \
167+
-type d -name '__pycache__' -prune -o \
168+
-type d -name 'node_modules' -prune -o \
169+
-regex ".*[.]md" -print
170+
); do
171+
markdown-link-check \
172+
--quiet \
173+
--config "./.markdown-link-check.json" \
174+
"$file"
175+
STATUS=$(( $STATUS + $? ))
176+
done
177+
exit $STATUS
178+
'
179+
fi
180+
181+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
182+
markdown:fix:
183+
desc: Automatically correct linting violations in Markdown files where possible
184+
deps:
185+
- task: npm:install-deps
186+
cmds:
187+
- npx markdownlint-cli --fix "**/*.md"
188+
189+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
190+
markdown:lint:
191+
desc: Check for problems in Markdown files
192+
deps:
193+
- task: npm:install-deps
194+
cmds:
195+
- npx markdownlint-cli "**/*.md"
196+
197+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/npm-task/Taskfile.yml
198+
npm:install-deps:
199+
desc: Install dependencies managed by npm
200+
cmds:
201+
- npm install
202+
117203
test:
118204
desc: Run tests
119205
cmds:
@@ -153,4 +239,3 @@ vars:
153239
# `-ldflags` flag to use for `go test` command
154240
# TODO: define flag if required by the project, or leave empty if not needed.
155241
TEST_LDFLAGS:
156-

0 commit comments

Comments
 (0)