|
1 | 1 | name: Check Spelling
|
2 | 2 |
|
3 |
| -# Comment management is handled through a secondary job, for details see: |
4 |
| -# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions |
5 |
| -# |
6 |
| -# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment |
7 |
| -# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare) |
8 |
| -# it needs `contents: write` in order to add a comment. |
9 |
| -# |
10 |
| -# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment |
11 |
| -# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment) |
12 |
| -# it needs `pull-requests: write` in order to manipulate those comments. |
13 |
| - |
14 |
| -# Updating pull request branches is managed via comment handling. |
15 |
| -# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list |
16 |
| -# |
17 |
| -# These elements work together to make it happen: |
18 |
| -# |
19 |
| -# `on.issue_comment` |
20 |
| -# This event listens to comments by users asking to update the metadata. |
21 |
| -# |
22 |
| -# `jobs.update` |
23 |
| -# This job runs in response to an issue_comment and will push a new commit |
24 |
| -# to update the spelling metadata. |
25 |
| -# |
26 |
| -# `with.experimental_apply_changes_via_bot` |
27 |
| -# Tells the action to support and generate messages that enable it |
28 |
| -# to make a commit to update the spelling metadata. |
29 |
| -# |
30 |
| -# `with.ssh_key` |
31 |
| -# In order to trigger workflows when the commit is made, you can provide a |
32 |
| -# secret (typically, a write-enabled github deploy key). |
33 |
| -# |
34 |
| -# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key |
35 |
| - |
36 |
| -# Sarif reporting |
37 |
| -# |
38 |
| -# Access to Sarif reports is generally restricted (by GitHub) to members of the repository. |
39 |
| -# |
40 |
| -# Requires enabling `security-events: write` |
41 |
| -# and configuring the action with `use_sarif: 1` |
42 |
| -# |
43 |
| -# For information on the feature, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Sarif-output |
44 |
| - |
45 |
| -# Minimal workflow structure: |
46 |
| -# |
47 |
| -# on: |
48 |
| -# push: |
49 |
| -# ... |
50 |
| -# pull_request_target: |
51 |
| -# ... |
52 |
| -# jobs: |
53 |
| -# # you only want the spelling job, all others should be omitted |
54 |
| -# spelling: |
55 |
| -# # remove `security-events: write` and `use_sarif: 1` |
56 |
| -# # remove `experimental_apply_changes_via_bot: 1` |
57 |
| -# ... otherwise adjust the `with:` as you wish |
58 |
| - |
59 | 3 | on:
|
60 |
| - push: |
61 |
| - branches: |
62 |
| - - "**" |
63 |
| - tags-ignore: |
64 |
| - - "**" |
65 | 4 | pull_request:
|
66 | 5 | branches:
|
67 | 6 | - "**"
|
|
141 | 80 | cspell:sql/src/tsql.txt
|
142 | 81 | cspell:terraform/dict/terraform.txt
|
143 | 82 | cspell:typescript/dict/typescript.txt
|
144 |
| - check_extra_dictionaries: '' |
| 83 | + check_extra_dictionaries: "" |
145 | 84 | only_check_changed_files: true
|
146 | 85 | longest_word: "10"
|
0 commit comments