summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorBertrand Yuan <bert.yuan@outlook.com>2025-12-15 23:56:25 +0800
committerBertrand Yuan <bert.yuan@outlook.com>2025-12-15 23:56:25 +0800
commit48b07bc308a35734a6a7a305c8fdccbfa47de7d8 (patch)
treea0f03dc976d1f00c7ed5814a3bce298b9cdf228b /.github
parent5b7ccf0b671e2999b62befc729a3e517a0433728 (diff)
build(workflow): adjust workflow strategy
The biome-ci is not applicable in this project, therefore, `biome-ci.yaml` is deprecated. I add a new workflow to check typos in `/docs`. (though `/docs` remains to be added now)
Diffstat (limited to '.github')
-rw-r--r--.github/workflows/biome-ci.yaml18
-rw-r--r--.github/workflows/codespell-docs.yml57
2 files changed, 57 insertions, 18 deletions
diff --git a/.github/workflows/biome-ci.yaml b/.github/workflows/biome-ci.yaml
deleted file mode 100644
index 563ae5b..0000000
--- a/.github/workflows/biome-ci.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-name: Biome CI
-
-on:
- push:
- pull_request:
-
-jobs:
- quality:
- runs-on: ubuntu-latest
- steps:
- - name: Checkout
- uses: actions/checkout@v4
- - name: Setup Biome
- uses: biomejs/setup-biome@v2
- with:
- version: latest
- - name: Run Biome
- run: biome ci .
diff --git a/.github/workflows/codespell-docs.yml b/.github/workflows/codespell-docs.yml
new file mode 100644
index 0000000..d6409a1
--- /dev/null
+++ b/.github/workflows/codespell-docs.yml
@@ -0,0 +1,57 @@
+# Codespell configuration inlined in this workflow (no .codespellrc needed)
+---
+name: Codespell
+
+on:
+ push:
+ branches: ['**']
+ pull_request:
+ branches: ['**']
+
+permissions:
+ contents: read
+
+jobs:
+ codespell:
+ name: Check for spelling errors
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Annotate locations with typos
+ uses: codespell-project/codespell-problem-matcher@v1
+
+ - name: Codespell
+ uses: codespell-project/actions-codespell@v2
+ with:
+ path: ./docs/
+ # filenames and hidden files
+ check_filenames: true
+ check_hidden: true
+ # skip list
+ skip: |
+ .git
+ .husky
+ .vscode
+ .idea
+ .venv
+ venv
+ node_modules
+ dist
+ build
+ out
+ coverage
+ *.lock
+ *.min.js
+ *.svg
+ *.pdf
+ *.png
+ *.jpg
+ package.json
+ package-lock.json
+ # Optional: Proper Noun Whitelist File
+ ignore_words_file: .codespellignore
+ # Fail CI on errors, set to true to only warn
+ only_warn: true