-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
enhanced spell check logic Signed-off-by: Praveen K Pandey <[email protected]>
- Loading branch information
1 parent
8f09d65
commit 40f01df
Showing
1 changed file
with
17 additions
and
104 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,109 +1,22 @@ | ||
name: "Spell check" | ||
name: Spellcheck | ||
# Controls when the action will run. | ||
on: | ||
# Triggers the workflow on push or pull request events but only for the main branch | ||
push: | ||
branches: | ||
- "**" | ||
tags-ignore: | ||
- "**" | ||
pull_request_target: | ||
branches: | ||
- "**" | ||
types: | ||
- 'opened' | ||
- 'reopened' | ||
- 'synchronize' | ||
issue_comment: | ||
types: | ||
- 'created' | ||
|
||
branches: [ master ] | ||
pull_request: | ||
branches: [ master ] | ||
# Allows you to run this workflow manually from the Actions tab | ||
workflow_dispatch: | ||
# A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
jobs: | ||
spelling: | ||
name: Check Spelling | ||
permissions: | ||
contents: read | ||
pull-requests: read | ||
actions: read | ||
security-events: write | ||
outputs: | ||
followup: ${{ steps.spelling.outputs.followup }} | ||
# This workflow contains a single job called "build" | ||
build: | ||
# The type of runner that the job will run on | ||
runs-on: ubuntu-latest | ||
if: ${{ contains(github.event_name, 'pull_request') || github.event_name == 'push' }} | ||
concurrency: | ||
group: spelling-${{ github.event.pull_request.number || github.ref }} | ||
# note: If you use only_check_changed_files, you do not want cancel-in-progress | ||
cancel-in-progress: true | ||
# Steps represent a sequence of tasks that will be executed as part of the job | ||
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: 1 | ||
spell_check_this: check-spelling/spell-check-this@prerelease | ||
post_comment: 0 | ||
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: ${{ (!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 | ||
|
||
comment-push: | ||
name: Report (Push) | ||
# If your workflow isn't running on push, you can remove this job | ||
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 | ||
with: | ||
checkout: true | ||
spell_check_this: check-spelling/spell-check-this@prerelease | ||
task: ${{ needs.spelling.outputs.followup }} | ||
|
||
comment-pr: | ||
name: Report (PR) | ||
# If you workflow isn't running on pull_request*, you can remove this job | ||
runs-on: ubuntu-latest | ||
needs: spelling | ||
permissions: | ||
contents: read | ||
pull-requests: write | ||
if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request') | ||
steps: | ||
- name: comment | ||
uses: check-spelling/check-spelling@main | ||
with: | ||
checkout: true | ||
spell_check_this: check-spelling/spell-check-this@prerelease | ||
task: ${{ needs.spelling.outputs.followup }} | ||
experimental_apply_changes_via_bot: 1 | ||
|
||
update: | ||
name: Update PR | ||
permissions: | ||
contents: write | ||
pull-requests: write | ||
actions: read | ||
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 }}" | ||
# Spellcheck | ||
- uses: actions/checkout@v2 | ||
- uses: igsekor/[email protected] | ||
Check notice on line 21 in .github/workflows/spellcheck.yml
|
||
name: Spellcheck |