From 596463f9db157adda18ebead92d6c9044a3bfa8b Mon Sep 17 00:00:00 2001 From: Sarah Gerrard <98355961+LadyBluenotes@users.noreply.github.com> Date: Mon, 17 Nov 2025 18:35:00 +0000 Subject: [PATCH 1/5] Fix spellcheck workflow --- .github/actions/spelling/.spellcheck.yml | 32 ++++++++ .github/workflows/spelling.yml | 98 +++++------------------- 2 files changed, 52 insertions(+), 78 deletions(-) create mode 100644 .github/actions/spelling/.spellcheck.yml diff --git a/.github/actions/spelling/.spellcheck.yml b/.github/actions/spelling/.spellcheck.yml new file mode 100644 index 000000000..4078572a5 --- /dev/null +++ b/.github/actions/spelling/.spellcheck.yml @@ -0,0 +1,32 @@ +matrix: + - name: Markdown + sources: + - "src/routes/**/*.mdx" + - "README.md" + - "WRITING.md" + - "CONTRIBUTING.md" + default_encoding: utf-8 + aspell: + lang: en + dictionary: + wordlists: + - .github/actions/spelling/allow.txt + encoding: utf-8 + pipeline: + - pyspelling.filters.markdown: + markdown_extensions: + - pymdownx.superfences + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + +wordlists: + - .github/actions/spelling/allow.txt + +allow_patterns: + - .github/actions/spelling/patterns.txt + +forbidden: + - .github/actions/spelling/forbidden.txt diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml index e69f4577d..943923898 100644 --- a/.github/workflows/spelling.yml +++ b/.github/workflows/spelling.yml @@ -1,4 +1,4 @@ -name: Check Spelling +name: Spellcheck on: push: @@ -7,91 +7,33 @@ on: paths: - "**/routes/**" - "**.mdx" - pull_request_target: + pull_request: branches: - "**" paths: - "**/routes/**" - "**.mdx" - types: - - "opened" - - "reopened" - - "synchronize" - issue_comment: - types: - - "created" - schedule: - - cron: "0 12 * * *" -jobs: - spelling: - - name: Check Spelling - runs-on: ubuntu-latest - permissions: - contents: read - pull-requests: read - actions: read - security-events: write - outputs: - followup: ${{ steps.spelling.outputs.followup }} - if: ${{ github.event_name == 'pull_request' || github.event_name == 'push'}} - concurrency: - group: spelling-${{ github.event.pull_request.number || github.ref }} - steps: - - name: check-spelling - id: spelling - uses: check-spelling/check-spelling@main - with: - suppress_push_for_open_pull_request: ${{ github.actor != 'dependabot[bot]' && 1 }} - checkout: true - check_file_names: 0 - spell_check_this: check-spelling/spell-check-this@main - use_magic_file: 1 - report-timing: 1 - warnings: bad-regex,deprecated-feature,large-file,limited-references,noisy-file,non-alpha-in-dictionary,token-is-substring,whitespace-in-dictionary,unsupported-configuration,no-files-to-check - output: sarif - use_sarif: ${{ (!github.event.pull_request || (github.event.pull_request.head.repo.full_name == github.repository)) && 1 }} - extra_dictionary_limit: 20 - extra_dictionaries: cspell:software-terms/dict/softwareTerms.txt - sarif_file: results.sarif - - name: Upload SARIF to GitHub Code Scanning - uses: github/codeql-action/upload-sarif@v3 - with: - sarif_file: results.sarif +permissions: + contents: read - comment-push: - name: Report (Push) +jobs: + spellcheck: + name: GitHub Spellcheck runs-on: ubuntu-latest - needs: spelling - permissions: - contents: write - if: (success() || failure()) && needs.spelling.outputs.followup && github.event_name == 'push' steps: - - name: comment - uses: check-spelling/check-spelling@main + - name: Check out code + uses: actions/checkout@v3 + - name: Check Changed Files + uses: tj-actions/changed-files@v45 + id: changed_files with: - checkout: true - spell_check_this: check-spelling/spell-check-this@main - task: ${{ needs.spelling.outputs.followup }} - - update: - name: Update PR - permissions: - contents: write - pull-requests: write - runs-on: ubuntu-latest - if: ${{ - github.event_name == 'issue_comment' && - github.event.issue.pull_request && - contains(github.event.comment.body, '@check-spelling-bot apply') - }} - concurrency: - group: spelling-update-${{ github.event.issue.number }} - cancel-in-progress: false - steps: - - name: apply spelling updates - uses: check-spelling/check-spelling@main + files: | + src/routes/**/*.mdx + - name: Run Spellcheck + id: spellcheck + uses: rojopolis/spellcheck-github-actions@0.54.0 with: - checkout: true - spell_check_this: check-spelling/spell-check-this@main - task: ${{ needs.spelling.outputs.followup }} + config_path: .github/actions/spelling/spellcheck.yml + task_name: Markdown + source_files: ${{ steps.changed_files.outputs.all_changed_files }} From af00615207f3dafcf6f5150d00de86196f2edaa0 Mon Sep 17 00:00:00 2001 From: Sarah Gerrard <98355961+LadyBluenotes@users.noreply.github.com> Date: Mon, 17 Nov 2025 18:38:47 +0000 Subject: [PATCH 2/5] fix workflow error --- .github/workflows/spelling.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml index 943923898..a1e826a1a 100644 --- a/.github/workflows/spelling.yml +++ b/.github/workflows/spelling.yml @@ -28,8 +28,8 @@ jobs: uses: tj-actions/changed-files@v45 id: changed_files with: - files: | - src/routes/**/*.mdx + files: | + src/routes/**/*.mdx - name: Run Spellcheck id: spellcheck uses: rojopolis/spellcheck-github-actions@0.54.0 From e8e0dffe792e174eac514d6dccd45f3048bb476c Mon Sep 17 00:00:00 2001 From: Sarah Gerrard <98355961+LadyBluenotes@users.noreply.github.com> Date: Mon, 17 Nov 2025 18:50:21 +0000 Subject: [PATCH 3/5] fix file path? --- .github/workflows/spelling.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml index a1e826a1a..8ffb6973c 100644 --- a/.github/workflows/spelling.yml +++ b/.github/workflows/spelling.yml @@ -34,6 +34,6 @@ jobs: id: spellcheck uses: rojopolis/spellcheck-github-actions@0.54.0 with: - config_path: .github/actions/spelling/spellcheck.yml + config_path: /.github/actions/spelling/spellcheck.yml task_name: Markdown source_files: ${{ steps.changed_files.outputs.all_changed_files }} From 0417d7299ee520092c20c0fe9224e5f11a5e94c5 Mon Sep 17 00:00:00 2001 From: Sarah Gerrard <98355961+LadyBluenotes@users.noreply.github.com> Date: Mon, 17 Nov 2025 18:50:50 +0000 Subject: [PATCH 4/5] fix file paths? --- .github/actions/spelling/.spellcheck.yml | 6 +++--- .github/workflows/spelling.yml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/actions/spelling/.spellcheck.yml b/.github/actions/spelling/.spellcheck.yml index 4078572a5..9b739cbb4 100644 --- a/.github/actions/spelling/.spellcheck.yml +++ b/.github/actions/spelling/.spellcheck.yml @@ -10,7 +10,7 @@ matrix: lang: en dictionary: wordlists: - - .github/actions/spelling/allow.txt + - ./.github/actions/spelling/allow.txt encoding: utf-8 pipeline: - pyspelling.filters.markdown: @@ -23,10 +23,10 @@ matrix: - pre wordlists: - - .github/actions/spelling/allow.txt + - ./.github/actions/spelling/allow.txt allow_patterns: - - .github/actions/spelling/patterns.txt + - ./.github/actions/spelling/patterns.txt forbidden: - .github/actions/spelling/forbidden.txt diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml index 8ffb6973c..83693a23a 100644 --- a/.github/workflows/spelling.yml +++ b/.github/workflows/spelling.yml @@ -34,6 +34,6 @@ jobs: id: spellcheck uses: rojopolis/spellcheck-github-actions@0.54.0 with: - config_path: /.github/actions/spelling/spellcheck.yml + config_path: ./.github/actions/spelling/spellcheck.yml task_name: Markdown source_files: ${{ steps.changed_files.outputs.all_changed_files }} From b34866f50c133bbdd13810306545359ebc63b657 Mon Sep 17 00:00:00 2001 From: Sarah Gerrard <98355961+LadyBluenotes@users.noreply.github.com> Date: Mon, 17 Nov 2025 18:52:16 +0000 Subject: [PATCH 5/5] use canonical version of spellcheck action --- .github/workflows/spelling.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml index 83693a23a..558422565 100644 --- a/.github/workflows/spelling.yml +++ b/.github/workflows/spelling.yml @@ -32,7 +32,7 @@ jobs: src/routes/**/*.mdx - name: Run Spellcheck id: spellcheck - uses: rojopolis/spellcheck-github-actions@0.54.0 + uses: rojopolis/spellcheck-github-actions@v0 with: config_path: ./.github/actions/spelling/spellcheck.yml task_name: Markdown