You've already forked library-registry
mirror of
https://github.com/arduino/library-registry.git
synced 2025-07-31 01:03:09 +03:00
Simplify code spell CI system
Now that the parser tool is moved out of the repository, it makes less sense to use the taskfile-based approach for the CI infrastructure. In order to make the repository more contributor-friendly, the spell checking system is now reduced to a single workflow file.
This commit is contained in:
@ -1,6 +0,0 @@
|
||||
[codespell]
|
||||
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
|
||||
ignore-words-list = ,
|
||||
check-filenames =
|
||||
check-hidden =
|
||||
skip = go.mod,go.sum,./repositories.txt,./.git,./manager/manager,./manager/manager.exe
|
25
.github/workflows/spell-check.yml
vendored
25
.github/workflows/spell-check.yml
vendored
@ -10,6 +10,8 @@ on:
|
||||
schedule:
|
||||
# Run every Tuesday at 03:00 UTC to catch breakage caused by updates to the dictionary
|
||||
- cron: "0 3 * * 2"
|
||||
workflow_dispatch:
|
||||
repository_dispatch:
|
||||
|
||||
jobs:
|
||||
spellcheck:
|
||||
@ -19,19 +21,12 @@ jobs:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
|
||||
- name: Install Python
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: "3.8"
|
||||
|
||||
- name: Install Poetry
|
||||
run: pip install poetry
|
||||
|
||||
- name: Install Taskfile
|
||||
uses: arduino/actions/setup-taskfile@master
|
||||
with:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
version: 3.x
|
||||
|
||||
- name: Spell check
|
||||
run: task check-spelling
|
||||
uses: codespell-project/actions-codespell@master
|
||||
with:
|
||||
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
|
||||
ignore_words_list:
|
||||
builtin: clear,informal,en-GB_to_en-US
|
||||
check_filenames: true
|
||||
check_hidden: true
|
||||
skip: ./.git,./repositories.txt
|
||||
|
11
Taskfile.yml
11
Taskfile.yml
@ -10,7 +10,6 @@ tasks:
|
||||
- task: docs:check-license
|
||||
- task: docs:check-links
|
||||
- task: docs:check-formatting
|
||||
- task: check-spelling
|
||||
|
||||
docs:check-license:
|
||||
desc: Check if the license file is correctly formatted
|
||||
@ -53,11 +52,6 @@ tasks:
|
||||
cmds:
|
||||
- npx {{.PRETTIER}} --check "**/*.md"
|
||||
|
||||
check-spelling:
|
||||
desc: Check for commonly misspelled words
|
||||
cmds:
|
||||
- poetry install --no-root
|
||||
- poetry run codespell {{.CODESPELL_SKIP_OPTION}} {{.CODESPELL_IGNORE_WORDS_OPTION}}
|
||||
|
||||
config:check:
|
||||
desc: Lint and check formatting of configuration files
|
||||
@ -79,8 +73,3 @@ tasks:
|
||||
cmds:
|
||||
- npx {{.PRETTIER}} --write "**/*.{yml,yaml,json}"
|
||||
|
||||
correct-spelling:
|
||||
desc: Correct commonly misspelled words where possible
|
||||
cmds:
|
||||
- poetry install --no-root
|
||||
- poetry run codespell --write-changes {{.CODESPELL_SKIP_OPTION}} {{.CODESPELL_IGNORE_WORDS_OPTION}}
|
||||
|
22
poetry.lock
generated
22
poetry.lock
generated
@ -1,22 +0,0 @@
|
||||
[[package]]
|
||||
category = "dev"
|
||||
description = "Codespell"
|
||||
name = "codespell"
|
||||
optional = false
|
||||
python-versions = ">=3.5"
|
||||
version = "2.0.0"
|
||||
|
||||
[package.extras]
|
||||
dev = ["check-manifest", "flake8", "pytest", "pytest-cov", "pytest-dependency"]
|
||||
hard-encoding-detection = ["chardet"]
|
||||
|
||||
[metadata]
|
||||
content-hash = "04bfba866bc7b58afdfc851fc8ec7e13967445b6124f0a03e78e8fdedd70c6e3"
|
||||
lock-version = "1.0"
|
||||
python-versions = "^3.8"
|
||||
|
||||
[metadata.files]
|
||||
codespell = [
|
||||
{file = "codespell-2.0.0-py3-none-any.whl", hash = "sha256:a10b8bbb9f678e4edff7877af1f654fdc9e27c205f952c3ddee2981ad02ec5f2"},
|
||||
{file = "codespell-2.0.0.tar.gz", hash = "sha256:dd9983e096b9f7ba89dd2d2466d1fc37231d060f19066331b9571341363c77b8"},
|
||||
]
|
@ -1,11 +0,0 @@
|
||||
[tool.poetry]
|
||||
name = "library-manager-list"
|
||||
version = "0.0.0"
|
||||
description = "Arduino Library Manager list"
|
||||
authors = ["Arduino <info@arduino.cc>"]
|
||||
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.8"
|
||||
|
||||
[tool.poetry.dev-dependencies]
|
||||
codespell = ">=2.0.0"
|
Reference in New Issue
Block a user