2020-04-22 19:07:51 +05:30
|
|
|
---
|
2020-06-23 00:09:42 +05:30
|
|
|
# Error: gitlab.VersionText
|
|
|
|
|
#
|
2020-04-22 19:07:51 +05:30
|
|
|
# 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.
|
|
|
|
|
#
|
2020-07-28 23:09:34 +05:30
|
|
|
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
|
2020-04-22 19:07:51 +05:30
|
|
|
extends: existence
|
2021-01-29 00:20:46 +05:30
|
|
|
message: 'This introduced-in line is not formatted correctly.'
|
2020-04-22 19:07:51 +05:30
|
|
|
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text
|
|
|
|
|
level: error
|
|
|
|
|
scope: raw
|
|
|
|
|
raw:
|
2021-01-29 00:20:46 +05:30
|
|
|
- '> (- ){0}\[?Introduced.+\n[^\n`]'
|
