Skip to content

Commit 5df4c0c

Browse files
MatteoPologrutoMatteoPologruto
authored
Merge pull request #20 from arduino/check-markdown
Add CI workflow to check Markdown files for problems
2 parents 44dbe28 + 9e1b368 commit 5df4c0c

9 files changed

+1603
-1
lines changed

‎.github/workflows/check-markdown-task.yml

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
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+
outputs:
45+
result: ${{ steps.determination.outputs.result }}
46+
steps:
47+
- name: Determine if the rest of the workflow should run
48+
id: determination
49+
run: |
50+
RELEASE_BRANCH_REGEX="refs/heads/[0-9]+.[0-9]+.x"
51+
# The `create` event trigger doesn't support `branches` filters, so it's necessary to use Bash instead.
52+
if [[
53+
"${{ github.event_name }}" != "create" ||
54+
"${{ github.ref }}" =~ $RELEASE_BRANCH_REGEX
55+
]]; then
56+
# Run the other jobs.
57+
RESULT="true"
58+
else
59+
# There is no need to run the other jobs.
60+
RESULT="false"
61+
fi
62+
63+
echo "::set-output name=result::$RESULT"
64+
65+
lint:
66+
needs: run-determination
67+
if: needs.run-determination.outputs.result == 'true'
68+
runs-on: ubuntu-latest
69+
70+
steps:
71+
- name: Checkout repository
72+
uses: actions/checkout@v3
73+
74+
- name: Setup Node.js
75+
uses: actions/setup-node@v3
76+
with:
77+
node-version: ${{ env.NODE_VERSION }}
78+
79+
- name: Initialize markdownlint-cli problem matcher
80+
uses: xt0rted/markdownlint-problem-matcher@v1
81+
82+
- name: Install Task
83+
uses: arduino/setup-task@v1
84+
with:
85+
repo-token: ${{ secrets.GITHUB_TOKEN }}
86+
version: 3.x
87+
88+
- name: Lint
89+
run: task markdown:lint
90+
91+
links:
92+
needs: run-determination
93+
if: needs.run-determination.outputs.result == 'true'
94+
runs-on: ubuntu-latest
95+
96+
steps:
97+
- name: Checkout repository
98+
uses: actions/checkout@v3
99+
100+
- name: Setup Node.js
101+
uses: actions/setup-node@v3
102+
with:
103+
node-version: ${{ env.NODE_VERSION }}
104+
105+
- name: Install Task
106+
uses: arduino/setup-task@v1
107+
with:
108+
repo-token: ${{ secrets.GITHUB_TOKEN }}
109+
version: 3.x
110+
111+
- name: Check links
112+
run: task --silent markdown:check-links

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/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 & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11

22
[![GoDoc](https://godoc.org/github.com/arduino/go-properties-orderedmap?status.svg)](https://godoc.org/github.com/arduino/go-properties-orderedmap)
33
[![Check License status](https://github.com/arduino/go-properties-orderedmap/actions/workflows/check-license.yml/badge.svg)](https://github.com/arduino/go-properties-orderedmap/actions/workflows/check-license.yml)
4+
[![Check Markdown status](https://github.com/arduino/go-properties-orderedmap/actions/workflows/check-markdown-task.yml/badge.svg)](https://github.com/arduino/go-properties-orderedmap/actions/workflows/check-markdown-task.yml)
45

5-
Package `properties` is a library for handling maps of hierarchical properties.
6+
Package `properties` is a library for handling maps of hierarchical properties.
67

78
This library is mainly used in the Arduino platform software to handle
89
configurations made of key/value pairs stored in files with an INI like

‎Taskfile.yml

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,88 @@ tasks:
2525
- task: general:cache-dep-licenses
2626
cmds:
2727
- licensed status
28+
29+
docs:generate:
30+
desc: Create all generated documentation content
31+
# This is an "umbrella" task used to call any documentation generation processes the project has.
32+
# It can be left empty if there are none.
33+
34+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
35+
markdown:check-links:
36+
desc: Check for broken links
37+
deps:
38+
- task: docs:generate
39+
- task: npm:install-deps
40+
cmds:
41+
- |
42+
if [[ "{{.OS}}" == "Windows_NT" ]]; then
43+
# npx --call uses the native shell, which makes it too difficult to use npx for this application on Windows,
44+
# so the Windows user is required to have markdown-link-check installed and in PATH.
45+
if ! which markdown-link-check &>/dev/null; then
46+
echo "markdown-link-check not found or not in PATH. Please install: https://github.com/tcort/markdown-link-check#readme"
47+
exit 1
48+
fi
49+
# Default behavior of the task on Windows is to exit the task when the first broken link causes a non-zero
50+
# exit status, but it's better to check all links before exiting.
51+
set +o errexit
52+
STATUS=0
53+
# Using -regex instead of -name to avoid Task's behavior of globbing even when quoted on Windows
54+
# The odd method for escaping . in the regex is required for windows compatibility because mvdan.cc/sh gives
55+
# \ characters special treatment on Windows in an attempt to support them as path separators.
56+
for file in $(
57+
find . \
58+
-type d -name '.git' -prune -o \
59+
-type d -name '.licenses' -prune -o \
60+
-type d -name '__pycache__' -prune -o \
61+
-type d -name 'node_modules' -prune -o \
62+
-regex ".*[.]md" -print
63+
); do
64+
markdown-link-check \
65+
--quiet \
66+
--config "./.markdown-link-check.json" \
67+
"$file"
68+
STATUS=$(( $STATUS + $? ))
69+
done
70+
exit $STATUS
71+
else
72+
npx --package=markdown-link-check --call='
73+
STATUS=0
74+
for file in $(
75+
find . \
76+
-type d -name '.git' -prune -o \
77+
-type d -name '.licenses' -prune -o \
78+
-type d -name '__pycache__' -prune -o \
79+
-type d -name 'node_modules' -prune -o \
80+
-regex ".*[.]md" -print
81+
); do
82+
markdown-link-check \
83+
--quiet \
84+
--config "./.markdown-link-check.json" \
85+
"$file"
86+
STATUS=$(( $STATUS + $? ))
87+
done
88+
exit $STATUS
89+
'
90+
fi
91+
92+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
93+
markdown:fix:
94+
desc: Automatically correct linting violations in Markdown files where possible
95+
deps:
96+
- task: npm:install-deps
97+
cmds:
98+
- npx markdownlint-cli --fix "**/*.md"
99+
100+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
101+
markdown:lint:
102+
desc: Check for problems in Markdown files
103+
deps:
104+
- task: npm:install-deps
105+
cmds:
106+
- npx markdownlint-cli "**/*.md"
107+
108+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/npm-task/Taskfile.yml
109+
npm:install-deps:
110+
desc: Install dependencies managed by npm
111+
cmds:
112+
- npm install

0 commit comments

Comments
 (0)