summaryrefslogtreecommitdiffstats
path: root/src/ansiblelint/rules/meta_runtime.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/ansiblelint/rules/meta_runtime.md')
-rw-r--r--src/ansiblelint/rules/meta_runtime.md46
1 files changed, 26 insertions, 20 deletions
diff --git a/src/ansiblelint/rules/meta_runtime.md b/src/ansiblelint/rules/meta_runtime.md
index 6ed6f17..3e05c59 100644
--- a/src/ansiblelint/rules/meta_runtime.md
+++ b/src/ansiblelint/rules/meta_runtime.md
@@ -1,26 +1,21 @@
# meta-runtime
-This rule checks the meta/runtime.yml `requires_ansible` key against the list of currently supported versions of ansible-core.
-
-This rule can produce messages such:
-
-- `requires_ansible` key must be set to a supported version.
-
-Currently supported versions of ansible-core are:
-
-- `2.9.10`
-- `2.11.x`
-- `2.12.x`
-- `2.13.x`
-- `2.14.x`
-- `2.15.x`
-- `2.16.x` (in development)
+This rule checks the meta/runtime.yml `requires_ansible` key against the list of
+currently supported versions of ansible-core.
This rule can produce messages such as:
-- `meta-runtime[unsupported-version]` - `requires_ansible` key must contain a supported version, shown in the list above.
-- `meta-runtime[invalid-version]` - `requires_ansible` key must be a valid version identifier.
+- `meta-runtime[unsupported-version]` - `requires_ansible` key must refer to a
+ currently supported version such as: >=2.14.0, >=2.15.0, >=2.16.0
+- `meta-runtime[invalid-version]` - `requires_ansible` is not a valid
+ requirement specification
+Please note that the linter will allow only a full version of Ansible such
+`2.16.0` and not allow their short form, like `2.16`. This is a safety measure
+for asking authors to mention an explicit version that they tested with. Over
+the years we spotted multiple problems caused by the use of the short versions,
+users ended up trying an outdated version that was never tested against by the
+collection maintainer.
## Problematic code
@@ -30,11 +25,10 @@ This rule can produce messages such as:
requires_ansible: ">=2.9"
```
-
```yaml
# runtime.yml
---
-requires_ansible: "2.9"
+requires_ansible: "2.15"
```
## Correct code
@@ -42,5 +36,17 @@ requires_ansible: "2.9"
```yaml
# runtime.yml
---
-requires_ansible: ">=2.9.10"
+requires_ansible: ">=2.15.0"
+```
+
+## Configuration
+
+In addition to the internal list of supported Ansible versions, users can
+configure additional values. This allows those that want to maintain content
+that requires a version of ansible-core that is already out of support.
+
+```yaml
+# Also recognize these versions of Ansible as supported:
+supported_ansible_also:
+ - "2.14"
```