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, 46 insertions, 0 deletions
diff --git a/src/ansiblelint/rules/meta_runtime.md b/src/ansiblelint/rules/meta_runtime.md
new file mode 100644
index 0000000..6ed6f17
--- /dev/null
+++ b/src/ansiblelint/rules/meta_runtime.md
@@ -0,0 +1,46 @@
+# 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 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.
+
+
+## Problematic code
+
+```yaml
+# runtime.yml
+---
+requires_ansible: ">=2.9"
+```
+
+
+```yaml
+# runtime.yml
+---
+requires_ansible: "2.9"
+```
+
+## Correct code
+
+```yaml
+# runtime.yml
+---
+requires_ansible: ">=2.9.10"
+```