gitlab-org--gitlab-foss/doc/.vale/gitlab/VersionText.yml

19 lines
631 B
YAML

---
# 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: 'This introduced-in section is not formatted correctly. Each entry must start with `> -` and long entries must be on one line.'
link: https://docs.gitlab.com/ee/development/documentation/versions.html
level: error
scope: raw
raw:
- '\n#.*\n\n> [^-].+\n[^\n`]'