diff options
Diffstat (limited to 'doc/.vale/gitlab/VersionText.yml')
-rw-r--r-- | doc/.vale/gitlab/VersionText.yml | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/.vale/gitlab/VersionText.yml b/doc/.vale/gitlab/VersionText.yml new file mode 100644 index 00000000000..c572a1a926c --- /dev/null +++ b/doc/.vale/gitlab/VersionText.yml @@ -0,0 +1,21 @@ +--- +# Checks that version text is formatted correctly. +# +# Specifically looks for either of the following that is immediately followed on the next line +# by content, which will break rendering: +# +# - `> Introduced` (version text without a link) +# - `> [Introduced` (version text with a link) +# +# Because it excludes `-`, it doesn't look for multi-line version text, for which content +# immediately on the next line is ok. However, this will often highlight where multi-line version +# text is attempted without `-` characters. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: existence +message: '"%s" is not formatted correctly.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text +level: error +scope: raw +raw: + - '> (- ){0}\[?Introduced.+\n.+' |