# spelling2.yml is blocked per https://github.com/check-spelling/check-spelling/security/advisories/GHSA-p8r9-69g4-jwqq
name: Spell checking
-# Comment management is handled through a secondary job, for details see:
-# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions
-#
-# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment
-# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare)
-# it needs `contents: write` in order to add a comment.
-#
-# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment
-# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment)
-# it needs `pull-requests: write` in order to manipulate those comments.
-
on:
push:
branches:
name: Spell checking
permissions:
contents: read
- pull-requests: read
actions: read
security-events: write
outputs:
uses: check-spelling/check-spelling@v0.0.21
with:
config: .github/actions/spell-check
- suppress_push_for_open_pull_request: 1
checkout: true
spell_check_this: check-spelling/spell-check-this@prerelease
post_comment: 0
cspell:python/src/python/python.txt
cspell:django/django.txt
check_extra_dictionaries: ''
-
- 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@v0.0.21
- with:
- config: .github/actions/spell-check
- 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:
- pull-requests: write
- if: (success() || failure()) && needs.spelling.outputs.followup && contains(github.event_name, 'pull_request')
- steps:
- - name: comment
- uses: check-spelling/check-spelling@prerelease
- with:
- config: .github/actions/spell-check
- checkout: true
- spell_check_this: check-spelling/spell-check-this@prerelease
- task: ${{ needs.spelling.outputs.followup }}