Attract contributors (at least one more) #1407
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
############################################################################### | |
# _ _ _ _ _____ _ | |
# | | | | | | | | | __ \(_) | |
# | | ___ | |__ _ __ | |_| |__ ___ | |__) |_ _ __ _ __ ___ _ __ | |
# _ | |/ _ \| '_ \| '_ \ | __| '_ \ / _ \ | _ /| | '_ \| '_ \ / _ \ '__| | |
# | |__| | (_) | | | | | | | | |_| | | | __/ | | \ \| | |_) | |_) | __/ | | |
# \____/ \___/|_| |_|_| |_| \__|_| |_|\___| |_| \_\_| .__/| .__/ \___|_| | |
# | | | | | |
# |_| |_| | |
# | |
# Copyright (c) 2024 Claudio André <claudioandre.br at gmail.com> | |
# | |
# This program comes with ABSOLUTELY NO WARRANTY; express or implied. | |
# | |
# This program is free software: you can redistribute it and/or modify | |
# it under the terms of the GNU General Public License as published by | |
# the Free Software Foundation, as expressed in version 2, seen at | |
# http://www.gnu.org/licenses/gpl-2.0.html | |
############################################################################### | |
# GitHub Action to run spell check on project | |
# More info at https://github.com/openwall/john-packages | |
--- | |
name: Check Spelling | |
"on": | |
push: | |
branches: | |
- "**" | |
tags-ignore: | |
- "**" | |
pull_request_target: | |
branches: | |
- "**" | |
types: | |
- "opened" | |
- "reopened" | |
- "synchronize" | |
issue_comment: | |
types: | |
- "created" | |
permissions: | |
contents: read | |
jobs: | |
spelling: | |
name: Check Spelling | |
permissions: | |
contents: read | |
pull-requests: read | |
actions: read | |
security-events: write | |
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 }} | |
cancel-in-progress: true | |
steps: | |
- name: Harden Runner | |
uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0 | |
with: | |
egress-policy: block | |
allowed-endpoints: > | |
api.github.com:443 | |
azure.archive.ubuntu.com:80 | |
github.com:443 | |
raw.githubusercontent.com:443 | |
- name: check-spelling | |
id: spelling | |
uses: check-spelling/check-spelling@26b46adbdebd5dd0b34c7155113d50c40f43fb22 # 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 | |
cspell:cpp/src/stdlib-c.txt | |
cspell:docker/src/docker-words.txt | |
cspell:shell/dict/shell-all-words.txt | |
comment-push: | |
name: Report (Push) | |
runs-on: ubuntu-latest | |
needs: spelling | |
permissions: | |
contents: write | |
if: (success() || failure()) && needs.spelling.outputs.followup && github.event_name == 'push' | |
steps: | |
- name: Harden Runner | |
uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0 | |
with: | |
egress-policy: block | |
allowed-endpoints: > | |
api.github.com:443 | |
github.com:443 | |
raw.githubusercontent.com:443 | |
- name: comment | |
uses: check-spelling/check-spelling@26b46adbdebd5dd0b34c7155113d50c40f43fb22 # main | |
with: | |
checkout: true | |
spell_check_this: check-spelling/spell-check-this@prerelease | |
task: ${{ needs.spelling.outputs.followup }} | |
comment-pr: | |
name: Report (PR) | |
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: Harden Runner | |
uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0 | |
with: | |
egress-policy: block | |
allowed-endpoints: > | |
api.github.com:443 | |
github.com:443 | |
raw.githubusercontent.com:443 | |
- name: comment | |
uses: check-spelling/check-spelling@26b46adbdebd5dd0b34c7155113d50c40f43fb22 # 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: Harden Runner | |
uses: step-security/harden-runner@0d381219ddf674d61a7572ddd19d7941e271515c # v2.9.0 | |
with: | |
egress-policy: audit | |
- name: apply spelling updates | |
uses: check-spelling/check-spelling@26b46adbdebd5dd0b34c7155113d50c40f43fb22 # main | |
with: | |
experimental_apply_changes_via_bot: 1 | |
checkout: true | |
ssh_key: "${{ secrets.CHECK_SPELLING }}" |