Skip to content

Commit c33b49c

Browse files
committed
Add source URL comments to standardized assets
This will make it easier for the maintainers to sync fixes and improvements in either direction between the upstream "template" assets and their installation in this repository.
1 parent 6ae2bca commit c33b49c

7 files changed

+12
-0
lines changed

.codespellrc

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc
12
# See: https://github.com/codespell-project/codespell#using-a-config-file
23
[codespell]
34
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:

.github/workflows/check-license.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-license.md
12
name: Check License
23

34
env:

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

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-markdown-task.md
12
name: Check Markdown
23

34
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows

.github/workflows/check-prettier-formatting-task.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-prettier-formatting-task.md
12
name: Check Prettier Formatting
23

34
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows

.github/workflows/spell-check-task.yml

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/spell-check-task.md
12
name: Spell Check
23

34
env:

.markdownlint.yml

+3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown/.markdownlint.yml
12
# 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.
25
# Note: Rules disabled solely because they are redundant to Prettier are marked with a "Prettier" comment.
36

47
default: false

Taskfile.yml

+4
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ tasks:
7373
- wget --quiet --output-document="{{.ACTION_METADATA_SCHEMA_PATH}}" https://json.schemastore.org/github-action
7474
- npx ajv-cli validate --strict=false -s "{{.ACTION_METADATA_SCHEMA_PATH}}" -d "action.yml"
7575

76+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
7677
markdown:lint:
7778
desc: Check for problems in Markdown files
7879
cmds:
@@ -84,6 +85,7 @@ tasks:
8485
cmds:
8586
- npx markdownlint-cli --fix "**/*.md"
8687

88+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-markdown-task/Taskfile.yml
8789
markdown:check-links:
8890
desc: Check for broken links
8991
deps:
@@ -132,13 +134,15 @@ tasks:
132134
cmds:
133135
- npx prettier --write .
134136

137+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check-task/Taskfile.yml
135138
general:check-spelling:
136139
desc: Check for commonly misspelled words
137140
deps:
138141
- task: poetry:install-deps
139142
cmds:
140143
- poetry run codespell
141144

145+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check-task/Taskfile.yml
142146
general:correct-spelling:
143147
desc: Correct commonly misspelled words where possible
144148
deps:

0 commit comments

Comments
 (0)