2021-07-14 00:23:12 +08:00
|
|
|
# spelling.yml is blocked per https://github.com/check-spelling/check-spelling/security/advisories/GHSA-g86g-chm8-7r2p
|
2020-05-21 11:19:08 +08:00
|
|
|
name: Spell checking
|
|
|
|
on:
|
2021-03-18 02:27:30 +08:00
|
|
|
pull_request_target:
|
2020-05-21 11:19:08 +08:00
|
|
|
push:
|
2021-12-13 03:42:04 +08:00
|
|
|
branches: ["**"]
|
|
|
|
tags-ignore: ["**"]
|
2020-05-21 11:19:08 +08:00
|
|
|
|
|
|
|
jobs:
|
2021-07-14 00:23:12 +08:00
|
|
|
spelling:
|
2020-05-21 11:19:08 +08:00
|
|
|
name: Spell checking
|
2021-12-13 03:42:04 +08:00
|
|
|
permissions:
|
|
|
|
contents: read
|
|
|
|
pull-requests: read
|
|
|
|
outputs:
|
|
|
|
internal_state_directory: ${{ steps.spelling.outputs.internal_state_directory }}
|
2020-05-21 11:19:08 +08:00
|
|
|
runs-on: ubuntu-latest
|
2021-12-13 03:42:04 +08:00
|
|
|
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
|
2020-05-21 11:19:08 +08:00
|
|
|
steps:
|
2021-03-18 02:27:30 +08:00
|
|
|
- name: checkout-merge
|
|
|
|
if: "contains(github.event_name, 'pull_request')"
|
2021-07-14 00:23:12 +08:00
|
|
|
uses: actions/checkout@v2
|
2020-05-21 11:19:08 +08:00
|
|
|
with:
|
2021-03-18 02:27:30 +08:00
|
|
|
ref: refs/pull/${{github.event.pull_request.number}}/merge
|
|
|
|
- name: checkout
|
2021-12-13 03:42:04 +08:00
|
|
|
if: github.event_name == 'push'
|
2021-07-14 00:23:12 +08:00
|
|
|
uses: actions/checkout@v2
|
2021-12-13 03:42:04 +08:00
|
|
|
- name: check-spelling
|
|
|
|
id: spelling
|
|
|
|
uses: check-spelling/check-spelling@v0.0.20-alpha3
|
2021-03-18 02:27:30 +08:00
|
|
|
with:
|
|
|
|
config: .github/actions/spell-check
|
2021-12-13 03:42:04 +08:00
|
|
|
suppress_push_for_open_pull_request: 1
|
|
|
|
post_comment: 0
|
2022-04-28 00:00:20 +08:00
|
|
|
dictionary_source_prefixes: '{"cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/master/dictionaries/"}'
|
2021-12-13 03:42:04 +08:00
|
|
|
extra_dictionaries:
|
|
|
|
cspell:filetypes/filetypes.txt
|
|
|
|
cspell:html/html.txt
|
|
|
|
cspell:css/css.txt
|
|
|
|
check_extra_dictionaries: ''
|
|
|
|
- name: store-comment
|
|
|
|
if: failure()
|
|
|
|
uses: actions/upload-artifact@v2
|
|
|
|
with:
|
|
|
|
retention-days: 1
|
|
|
|
name: "check-spelling-comment-${{ github.run_id }}"
|
|
|
|
path: |
|
|
|
|
${{ steps.spelling.outputs.internal_state_directory }}
|
|
|
|
|
|
|
|
comment:
|
|
|
|
name: Comment
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
needs: spelling
|
|
|
|
permissions:
|
|
|
|
contents: write
|
|
|
|
pull-requests: write
|
|
|
|
if: always() && needs.spelling.result == 'failure' && needs.spelling.outputs.internal_state_directory
|
|
|
|
steps:
|
|
|
|
- name: checkout
|
|
|
|
uses: actions/checkout@v2
|
|
|
|
- name: set up
|
|
|
|
run: |
|
|
|
|
mkdir /tmp/data
|
|
|
|
- name: retrieve-comment
|
|
|
|
uses: actions/download-artifact@v2
|
|
|
|
with:
|
|
|
|
name: "check-spelling-comment-${{ github.run_id }}"
|
|
|
|
path: /tmp/data
|
|
|
|
- name: comment
|
|
|
|
uses: check-spelling/check-spelling@v0.0.20-alpha3
|
|
|
|
with:
|
2022-01-24 21:31:29 +08:00
|
|
|
config: .github/actions/spell-check
|
2021-12-13 03:42:04 +08:00
|
|
|
custom_task: comment
|
|
|
|
internal_state_directory: /tmp/data
|