actions-codespell/action.yml at main · step-security/actions-codespell · 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
name: 'Codespell with annotations'
author: 'step-security'
description: 'Codespell with annotations for Pull Request'
inputs:
  check_filenames:
    description: 'If set, check file names as well'
    required: false
    default: ''
  check_hidden:
    description: 'If set, check hidden files (those starting with ".") as well'
    required: false
    default: ''
  exclude_file:
    description: 'File with lines that should not be checked for spelling mistakes'
    required: false
    default: ''
  skip:
    description: 'Comma-separated list of files to skip (it accepts globs as well)'
    required: false
    default: './.git'
  builtin:
    description: 'Comma-separated list of builtin dictionaries to include'
    required: false
    default: ''
  ignore_words_file:
    description: 'File with a list of words to be ignored. Words are case sensitive based on how they are written in the dictionary file'
    required: false
    default: ''
  ignore_words_list:
    description: 'Comma-separated list of words to be ignored. Words are case sensitive based on how they are written in the dictionary file'
    required: false
    default: ''
  uri_ignore_words_list:
    description: 'comma separated list of words to be ignored in URIs and emails only'
    required: false
    default: ''
  path:
    description: 'Path to run codespell in'
    required: false
    default: ''
  only_warn:
    description: 'If set, only warn, never error'
    required: false
    default: ''
runs:
  using: 'docker'
  image: 'docker://ghcr.io/step-security/actions-codespell/stable:v2.1.5@sha256:dd449fdffb2bff013775cc7dfb0e253b0244184f981ddbc8dc0105075f752a71' #v2.1.5
branding:
  icon: 'code'
  color: 'blue'