summaryrefslogtreecommitdiff
path: root/doc/.vale/gitlab/VersionText.yml
blob: 4fd80bc3f4e96a9cf2583bf752a9f6cdcd7c30e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
---
# Error: gitlab.VersionText
#
# Checks that multi-line version text is formatted correctly.
#
# Specifically, looks for multi-line version text that doesn't use `-` to make it a list.
# For example:
#
# - `> Introduced in GitLab 14.0.
# - `> Removed in GitLab 15.0.
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: existence
message: "Start each entry with `> -`. Keep long entries on one line."
link: https://docs.gitlab.com/ee/development/documentation/versions.html
level: error
scope: raw
raw:
  - '\n#.*\n\n> [^-].+\n[^\n`]'