vale-action/action.yml at reviewdog · vale-cli/vale-action · 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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
name: Vale Linter
description: The official GitHub Action for Vale -- install, manage, and run Vale with ease.
author: jdkato
branding:
  icon: check
  color: green

inputs:
  version:
    description: "The Vale CLI version to install."
    required: false
    default: "latest"

  files:
    description: 'The files to lint: "all" or "<some_folder>".'
    required: false
    default: all

  sync:
    description: |
      Run `vale sync` before linting [true,false].
      Set to `false` when the StylesPath is restored from a cache.
    required: false
    default: "true"

  debug:
    description: "Log debugging information to stdout."
    required: false
    default: "false"

  reporter:
    description: "Reporter of reviewdog command [github-pr-check,github-pr-review,github-pr-annotations,github-check]."
    required: false
    default: "github-pr-annotations"

  fail_on_error:
    description: |
      Exit code for reviewdog when errors are found [true,false]
      Default is `false`.
    required: false
    default: "false"

  fail_level:
    description: |
      The severity at which reviewdog exits with `1`
      [none,any,info,warning,error]. Takes precedence over `fail_on_error`,
      and needs reviewdog 0.21.0 or later.
    required: false
    default: ""

  level:
    description: |
      Report level for reviewdog [info,warning,error].
      Unset, the level follows `fail_on_error` and what Vale found.
    required: false
    default: ""

  filter_mode:
    description: |
      Filtering for the reviewdog command [added,diff_context,file,nofilter].
      Default is added.
    required: false
    default: "added"

  workdir:
    description: "The directory to run Vale in."
    required: false
    default: "."

  config:
    description: "A path to a .vale.ini file."
    required: false
    default: ""

  filter:
    description: |
      An expression to filter rules by, such as `.Level == "error"`.
    required: false
    default: ""

  glob:
    description: 'A glob pattern, such as `*.{md,txt}`.'
    required: false
    default: ""

  min_alert_level:
    description: "The minimum level to report [suggestion,warning,error]."
    required: false
    default: ""

  vale_flags:
    description: "Space-delimited list of flags for the Vale CLI."
    required: false
    default: ""

  separator:
    description: "Split character for input strings."
    required: false
    default: ""

  reviewdog_version:
    description: "The reviewdog version to install."
    required: false
    default: "0.21.0"

  reviewdog_url:
    description: "The URL to a tar.gz build of reviewdog to use in the action"
    required: false
    default: ""

  token:
    description: "The GitHub token to use."
    required: false
    default: ${{ github.token }}

runs:
  using: "node24"
  main: "dist/index.js"