96 lines
4.0 KiB
YAML
96 lines
4.0 KiB
YAML
name: Spell Check
|
|
|
|
# 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.
|
|
|
|
# Updating pull request branches is managed via comment handling.
|
|
# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list
|
|
#
|
|
# These elements work together to make it happen:
|
|
#
|
|
# `on.issue_comment`
|
|
# This event listens to comments by users asking to update the metadata.
|
|
#
|
|
# `jobs.update`
|
|
# This job runs in response to an issue_comment and will push a new commit
|
|
# to update the spelling metadata.
|
|
#
|
|
# `with.experimental_apply_changes_via_bot`
|
|
# Tells the action to support and generate messages that enable it
|
|
# to make a commit to update the spelling metadata.
|
|
#
|
|
# `with.ssh_key`
|
|
# In order to trigger workflows when the commit is made, you can provide a
|
|
# secret (typically, a write-enabled github deploy key).
|
|
#
|
|
# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key
|
|
|
|
on:
|
|
# Switch from `pull_request_target` event to reduce distraction from comments
|
|
# regarding errors reported in unmodified files.
|
|
pull_request:
|
|
branches:
|
|
- master
|
|
- "*-stable"
|
|
tags-ignore:
|
|
- "**"
|
|
types:
|
|
- 'opened'
|
|
- 'reopened'
|
|
- 'synchronize'
|
|
|
|
jobs:
|
|
spelling:
|
|
name: Spell Check
|
|
permissions:
|
|
contents: read
|
|
pull-requests: read
|
|
actions: read
|
|
outputs:
|
|
followup: ${{ steps.spelling.outputs.followup }}
|
|
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:
|
|
- name: check-spelling
|
|
id: spelling
|
|
uses: check-spelling/check-spelling@v0.0.24
|
|
with:
|
|
# This workflow runs in response to both `push` and `pull_request`, if there's an open `pull_request` in the same repository
|
|
# for a given branch, there's no reason to spend resources checking both the `push` and the `pull_request`, so this flag tells
|
|
# the action while running for the `push` to find the `pull_request` and stop working early:
|
|
suppress_push_for_open_pull_request: 1
|
|
# The action will manage checking out the repository itself instead of requiring the workflow to use `actions/checkout...`:
|
|
checkout: true
|
|
# If running without `: write`, posting a comment won't work, and for security `: write` permissions are left to a distinct
|
|
# (optional) job, here we skip trying to post a comment:
|
|
post_comment: 0
|
|
use_magic_file: 1
|
|
extra_dictionary_limit: 10
|
|
extra_dictionaries:
|
|
cspell:software-terms/software-terms.txt
|
|
cspell:php/php.txt
|
|
cspell:node/node.txt
|
|
cspell:django/django.txt
|
|
cspell:html/html.txt
|
|
cspell:npm/npm.txt
|
|
cspell:ruby/ruby.txt
|
|
cspell:fullstack/fullstack.txt
|
|
cspell:filetypes/filetypes.txt
|
|
check_extra_dictionaries: ''
|
|
dictionary_source_prefixes: >-
|
|
{"cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20241114/dictionaries/"}
|
|
|
|
# This workflow has opted not to use comments (users can view the report in GitHub Step Summary)
|