Vale CMS Need more than a rule playground? Explore
Asset Explorer

github

GitHub Actions annotations, one per alert, so each shows on its line in the pull request.

template cigithub Source

Getting started

Save the file as config/templates/github.tmpl under your StylesPath, then:

vale --output=github.tmpl .

github.tmpl

An output format, named with --output.
{{- /* GitHub Actions annotations: one workflow command per alert, so each
       shows up on the changed line in the pull request. Suggestions become
       notices, which GitHub shows without failing the check. */ -}}
{{- range .Files -}}
{{- $path := .Path -}}
{{- range .Alerts -}}
{{- $level := "notice" -}}
{{- if eq .Severity "error" -}}{{- $level = "error" -}}
{{- else if eq .Severity "warning" -}}{{- $level = "warning" -}}
{{- end -}}
::{{ $level }} file={{ $path }},line={{ .Line }},col={{ index .Span 0 }},endColumn={{ index .Span 1 }},title={{ .Check }}::{{ .Message }}
{{ end -}}
{{- end -}}