This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Check Spelling | ||
on: | ||
push: | ||
branches: | ||
- "**" | ||
tags-ignore: | ||
- "**" | ||
pull_request_target: | ||
branches: | ||
- "**" | ||
types: | ||
- "opened" | ||
- "reopened" | ||
- "synchronize" | ||
jobs: | ||
spelling: | ||
name: Check Spelling | ||
permissions: | ||
contents: read | ||
pull-requests: read | ||
actions: read | ||
security-events: write | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
- name: Run spell check | ||
uses: check-spelling/check-spelling@main | ||
with: | ||
checkout: true | ||
check_file_names: 1 | ||
spell_check_this: check-spelling/spell-check-this@main | ||
use_magic_file: 1 | ||
report-timing: 1 | ||
warnings: bad-regex,binary-file,deprecated-feature,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,token-is-substring,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration,no-files-to-check | ||
experimental_apply_changes_via_bot: 1 | ||
use_sarif: 1 | ||
extra_dictionary_limit: 20 | ||
extra_dictionaries: | ||
custom: .github/workflows/custom_dict.txt # Adjust the path to your custom dictionary | ||
Check failure on line 43 in .github/workflows/spell-check.yml GitHub Actions / Check SpellingInvalid workflow file
|
||
ignore: | ||
- .github/ | ||
comment-pr: | ||
name: Report (PR) | ||
runs-on: ubuntu-latest | ||
needs: spelling | ||
permissions: | ||
contents: read | ||
pull-requests: write | ||
if: success() || failure() | ||
steps: | ||
- name: Comment PR | ||
uses: check-spelling/check-spelling@main | ||
with: | ||
checkout: true | ||
spell_check_this: check-spelling/spell-check-this@main | ||
task: ${{ needs.spelling.outputs.followup }} | ||
experimental_apply_changes_via_bot: 1 | ||
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 | ||
with: | ||
experimental_apply_changes_via_bot: 1 | ||
checkout: true | ||
ssh_key: "${{ secrets.CHECK_SPELLING }}" |