GitHub-Actions/.github/actions/spelling/action.yml at dev · EasyOC/GitHub-Actions · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# This file needs to be present in this exact folder for the workflow using this action to be able to work with submodules.
name: Spelling
description: Checks for spelling errors in files.

inputs:
  # When updating check-spelling to a new version, check the release notes or the "dictionary-source-prefixes" parameter
  # of "action.yaml" according to the commit of the release to find out the dictionary version tag and update the
  # default value here and in the spelling workflow.
  dictionary-source-prefixes:
    description: >
      JSON map of prefixes for dictionary URLs, "cspell" is necessary. See
      https://github.com/check-spelling/check-spelling/blob/v0.0.21/action.yml#L67 for current version.
    required: false
    default: >
      {
        "cspell": "https://raw.githubusercontent.com/check-spelling/cspell-dicts/v20220816/dictionaries/"
      }
  extra-dictionaries:
    description: Space delimited list of URLs (or `prefix:`+path) to additional word lists
    required: false
    default: |
      cspell:aws/aws.txt
      cspell:csharp/csharp.txt
      cspell:css/css.txt
      cspell:django/django.txt
      cspell:dotnet/dotnet.txt
      cspell:filetypes/filetypes.txt
      cspell:html/html.txt
      cspell:npm/npm.txt
      cspell:rust/rust.txt
      cspell:scala/scala.txt
      cspell:software-terms/src/software-terms.txt
      cspell:node/node.txt
      cspell:typescript/typescript.txt
  config:
    description: Spelling configuration directory
    required: false
    default: .github/actions/spelling
  spell-check-this:
    description: Repository with default configuration to use, the default from Check Spelling is ''.
    required: false
    default: Lombiq/GitHub-Actions@dev
  post-comment:
    description: Flag for if check-spelling should post comment, the default is 1.
    required: false
    default: '1'
  task:
    description: Follow up task for check-spelling, the default is ''.
    required: false
    default: ''
outputs:
  followup:
    description: Check Spelling output for followup.
    value: ${{ steps.step-check-spelling.outputs.followup }}

runs:
  using: "composite"
  steps:
    - name: Check Spelling
      id: step-check-spelling
      # v0.0.21
      uses: check-spelling/check-spelling@d7cd2973c513e84354f9d6cf50a6417a628a78ce
      with:
        check_file_names: 1
        config: ${{ inputs.config }}
        dictionary_source_prefixes: ${{ inputs.dictionary-source-prefixes }}
        experimental_apply_changes_via_bot: 0
        extra_dictionaries: ${{ inputs.extra-dictionaries }}
        post_comment: ${{ inputs.post-comment }}
        spell_check_this: ${{ inputs.spell-check-this }}
        suppress_push_for_open_pull_request: 1
        task: ${{ inputs.task }}