Normalize version field for rules (#4431)

Author: ssbarnea

src/ansiblelint/_internal/rules.py

@@ -7,6 +7,8 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
+from packaging.version import InvalidVersion, Version
+
 from ansiblelint.constants import RULE_DOC_URL
 
 if TYPE_CHECKING:
@@ -41,7 +43,7 @@ class BaseRule:
     id: str = ""
     tags: list[str] = []
     description: str = ""
-    version_added: str = ""
+    version_changed: str = ""
     severity: str = ""
     link: str = ""
     has_dynamic_tags: bool = False
@@ -59,6 +61,13 @@ class BaseRule:
     # Allow rules to provide a custom short description instead of using __doc__
     _shortdesc: str = ""
 
+    def __init__(self) -> None:
+        try:
+            Version(self.version_changed)
+        except InvalidVersion:
+            msg = f"Rule {self.__class__.__name__} has an invalid version_changed field '{self.version_changed}', is should be a 'X.Y.Z' format value."
+            _logger.warning(msg)
+
     @property
     def help(self) -> str:
         """Return a help markdown string for the rule."""
@@ -195,7 +204,7 @@ class RuntimeErrorRule(BaseRule):
     _shortdesc = "Unexpected internal error"
     severity = "VERY_HIGH"
     tags = ["core"]
-    version_added = "v5.0.0"
+    version_changed = "5.0.0"
     _order = 0
     unloadable = True
 
@@ -207,7 +216,7 @@ class AnsibleParserErrorRule(BaseRule):
     description = "Ansible parser fails; this usually indicates an invalid file."
     severity = "VERY_HIGH"
     tags = ["core"]
-    version_added = "v5.0.0"
+    version_changed = "5.0.0"
     _order = 0
     unloadable = True
 
@@ -219,7 +228,7 @@ class LoadingFailureRule(BaseRule):
     description = "Linter failed to process a file, possible invalid file."
     severity = "VERY_HIGH"
     tags = ["core", "unskippable"]
-    version_added = "v4.3.0"
+    version_changed = "4.3.0"
     _help = LOAD_FAILURE_MD
     _order = 0
     _ids = {
@@ -235,6 +244,6 @@ class WarningRule(BaseRule):
     severity = "LOW"
     # should remain experimental as that would keep it warning only
     tags = ["core", "experimental"]
-    version_added = "v6.8.0"
+    version_changed = "6.8.0"
     _order = 0
     unloadable = True

src/ansiblelint/generate_docs.py

@@ -81,8 +81,8 @@ def rules_as_rich(rules: RulesCollection) -> Iterable[Table]:
         if rule.link:
             description += f" [(more)]({rule.link})"
         table.add_row("description", Markdown(description))
-        if rule.version_added:
-            table.add_row("version_added", rule.version_added)
+        if rule.version_changed:
+            table.add_row("version_changed", rule.version_changed)
         if rule.tags:
             table.add_row("tags", ", ".join(rule.tags))
         if rule.severity:

src/ansiblelint/rules/args.py

@@ -88,7 +88,7 @@ class ArgsRule(AnsibleLintRule):
     severity = "HIGH"
     description = "Check whether tasks are using correct module options."
     tags = ["syntax", "experimental"]
-    version_added = "v6.10.0"
+    version_changed = "6.10.0"
     module_aliases: dict[str, str] = {"block/always/rescue": "block/always/rescue"}
     _ids = {
         "args[module]": description,

src/ansiblelint/rules/avoid_implicit.py

@@ -24,7 +24,7 @@ class AvoidImplicitRule(AnsibleLintRule):
     )
     severity = "MEDIUM"
     tags = ["unpredictability"]
-    version_added = "v6.8.0"
+    version_changed = "6.8.0"
 
     def matchtask(
         self,

src/ansiblelint/rules/command_instead_of_module.py

@@ -42,7 +42,7 @@ class CommandsInsteadOfModulesRule(AnsibleLintRule):
     )
     severity = "HIGH"
     tags = ["command-shell", "idiom"]
-    version_added = "historic"
+    version_changed = "24.10.0"
 
     _commands = ["command", "shell"]
     _modules = {

src/ansiblelint/rules/command_instead_of_shell.py

@@ -46,7 +46,7 @@ class UseCommandInsteadOfShellRule(AnsibleLintRule, TransformMixin):
     )
     severity = "HIGH"
     tags = ["command-shell", "idiom"]
-    version_added = "historic"
+    version_changed = "6.18.0"
 
     def matchtask(
         self,

src/ansiblelint/rules/complexity.py

@@ -23,7 +23,7 @@ class ComplexityRule(AnsibleLintRule):
     description = "There should be limited tasks executed inside any file"
     severity = "MEDIUM"
     tags = ["experimental", "idiom"]
-    version_added = "v6.18.0 (last update)"
+    version_changed = "6.18.0"
     _re_templated_inside = re.compile(r".*\{\{.*\}\}.*\w.*$")
 
     def matchplay(self, file: Lintable, data: dict[str, Any]) -> list[MatchError]:

src/ansiblelint/rules/deprecated_bare_vars.py

@@ -45,7 +45,7 @@ class UsingBareVariablesIsDeprecatedRule(AnsibleLintRule):
     )
     severity = "VERY_HIGH"
     tags = ["deprecations"]
-    version_added = "historic"
+    version_changed = "6.19.0"
 
     def matchtask(
         self,

src/ansiblelint/rules/deprecated_local_action.py

@@ -35,7 +35,7 @@ class TaskNoLocalActionRule(AnsibleLintRule, TransformMixin):
     needs_raw_task = True
     severity = "MEDIUM"
     tags = ["deprecations"]
-    version_added = "v4.0.0"
+    version_changed = "4.0.0"
 
     def matchtask(
         self,

src/ansiblelint/rules/deprecated_module.py

@@ -23,7 +23,7 @@ class DeprecatedModuleRule(AnsibleLintRule):
     link = "https://docs.ansible.com/ansible/latest/collections/index_module.html"
     severity = "HIGH"
     tags = ["deprecations"]
-    version_added = "v4.0.0"
+    version_changed = "4.0.0"
 
     _modules = [
         "accelerate",