Normalize version field for rules

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",

src/ansiblelint/rules/empty_string_compare.py

@@ -27,7 +27,7 @@ class ComparisonToEmptyStringRule(AnsibleLintRule):
     )
     severity = "HIGH"
     tags = ["idiom", "opt-in"]
-    version_added = "v4.0.0"
+    version_changed = "4.0.0"
 
     empty_string_compare = re.compile(r"[=!]= ?(\"{2}|'{2})")
 

src/ansiblelint/rules/fqcn.py

@@ -103,7 +103,7 @@ class FQCNBuiltinsRule(AnsibleLintRule, TransformMixin):
         "Check whether actions are using using full qualified collection names."
     )
     tags = ["formatting"]
-    version_added = "v6.8.0"
+    version_changed = "6.8.0"
     module_aliases: dict[str, str] = {"block/always/rescue": "block/always/rescue"}
     _ids = {
         "fqcn[action-core]": "Use FQCN for builtin module actions",

src/ansiblelint/rules/galaxy.py

@@ -20,7 +20,7 @@ class GalaxyRule(AnsibleLintRule):
     description = "Confirm that collection's units are valid."
     severity = "MEDIUM"
     tags = ["metadata"]
-    version_added = "v6.11.0 (last update)"
+    version_changed = "6.11.0"
     _ids = {
         "galaxy[tags]": "galaxy.yaml must have one of the required tags",
         "galaxy[no-changelog]": "No changelog found. Please add a changelog file. Refer to the galaxy.md file for more info.",

src/ansiblelint/rules/galaxy_version_incorrect.py

@@ -20,7 +20,7 @@ class GalaxyVersionIncorrectRule(AnsibleLintRule):
     description = "Confirm via galaxy.yml file if collection version is greater than or equal to 1.0.0."
     severity = "MEDIUM"
     tags = ["opt-in", "metadata"]
-    version_added = "v24.7.0"
+    version_changed = "24.7.0"
 
     def matchplay(self, file: Lintable, data: dict[str, Any]) -> list[MatchError]:
         """Return matches found for a specific play (entry in playbook)."""

src/ansiblelint/rules/ignore_errors.py

@@ -24,7 +24,7 @@ class IgnoreErrorsRule(AnsibleLintRule):
     )
     severity = "LOW"
     tags = ["unpredictability"]
-    version_added = "v5.0.7"
+    version_changed = "5.0.7"
 
     def matchtask(
         self,

src/ansiblelint/rules/inline_env_var.py

@@ -41,7 +41,7 @@ class EnvVarsInCommandRule(AnsibleLintRule):
     )
     severity = "VERY_HIGH"
     tags = ["command-shell", "idiom"]
-    version_added = "historic"
+    version_changed = "5.0.11"
 
     expected_args = [
         "chdir",

src/ansiblelint/rules/jinja.py

@@ -98,7 +98,7 @@ class JinjaRule(AnsibleLintRule, TransformMixin):
     id = "jinja"
     severity = "LOW"
     tags = ["formatting"]
-    version_added = "v6.5.0"
+    version_changed = "6.5.0"
     _ansible_error_re = re.compile(
         (
             r"^(?P<error>.*): (?P<detail>.*)\. String: (?P<string>.*)$"

src/ansiblelint/rules/key_order.py

@@ -71,7 +71,7 @@ class KeyOrderRule(AnsibleLintRule, TransformMixin):
     id = "key-order"
     severity = "LOW"
     tags = ["formatting"]
-    version_added = "v6.6.2"
+    version_changed = "6.6.2"
     needs_raw_task = True
     _ids = {
         "key-order[task]": "You can improve the task key order",

src/ansiblelint/rules/latest.py

@@ -22,7 +22,7 @@ class LatestRule(AnsibleLintRule):
     )
     severity = "MEDIUM"
     tags = ["idempotency"]
-    version_added = "v6.5.2"
+    version_changed = "6.5.2"
     _ids = {
         "latest[git]": "Use a commit hash or tag instead of 'latest' for git",
         "latest[hg]": "Use a commit hash or tag instead of 'latest' for hg",

src/ansiblelint/rules/literal_compare.py

@@ -27,7 +27,7 @@ class ComparisonToLiteralBoolRule(AnsibleLintRule):
     )
     severity = "HIGH"
     tags = ["idiom"]
-    version_added = "v4.0.0"
+    version_changed = "4.0.0"
 
     literal_bool_compare = re.compile(r"[=!]= ?(True|true|False|false)")
 

src/ansiblelint/rules/loop_var_prefix.py

@@ -35,6 +35,7 @@ class RoleLoopVarPrefix(AnsibleLintRule):
         "loop-var-prefix[wrong]": "Loop variable name does not match regex.",
         "loop-var-prefix[missing]": "Replace unsafe implicit `item` loop variable.",
     }
+    version_changed = "6.7.0"
 
     def matchtask(
         self,

src/ansiblelint/rules/meta_incorrect.py

@@ -31,7 +31,7 @@ class MetaChangeFromDefaultRule(AnsibleLintRule):
     )
     severity = "HIGH"
     tags = ["metadata"]
-    version_added = "v4.0.0"
+    version_changed = "4.0.0"
 
     def matchyaml(self, file: Lintable) -> list[MatchError]:
         if file.kind != "meta" or not file.data:

src/ansiblelint/rules/meta_no_tags.py

@@ -30,7 +30,7 @@ class MetaTagValidRule(AnsibleLintRule):
     )
     severity = "HIGH"
     tags = ["metadata"]
-    version_added = "v4.0.0"
+    version_changed = "4.0.0"
 
     TAG_REGEXP = re.compile(r"^[a-z0-9]+$")
 

src/ansiblelint/rules/meta_runtime.py

@@ -28,7 +28,7 @@ class CheckRequiresAnsibleVersion(AnsibleLintRule):
     )
     severity = "VERY_HIGH"
     tags = ["metadata"]
-    version_added = "v6.11.0 (last update)"
+    version_changed = "6.11.0"
 
     _ids = {
         "meta-runtime[unsupported-version]": "'requires_ansible' key must refer to a currently supported version",

src/ansiblelint/rules/meta_video_links.py

@@ -28,7 +28,7 @@ class MetaVideoLinksRule(AnsibleLintRule):
     )
     severity = "LOW"
     tags = ["metadata"]
-    version_added = "v4.0.0"
+    version_changed = "4.0.0"
 
     VIDEO_REGEXP = {
         "google": re.compile(r"https://drive\.google\.com.*file/d/([0-9A-Za-z-_]+)/.*"),

src/ansiblelint/rules/name.py

@@ -31,7 +31,7 @@ class NameRule(AnsibleLintRule, TransformMixin):
     )
     severity = "MEDIUM"
     tags = ["idiom"]
-    version_added = "v6.9.1 (last update)"
+    version_changed = "6.9.1"
     _re_templated_inside = re.compile(r".*\{\{.*\}\}.*\w.*$")
     _ids = {
         "name[play]": "All plays should be named.",

src/ansiblelint/rules/no_changed_when.py

@@ -39,7 +39,7 @@ class CommandHasChangesCheckRule(AnsibleLintRule):
     id = "no-changed-when"
     severity = "HIGH"
     tags = ["command-shell", "idempotency"]
-    version_added = "historic"
+    version_changed = "6.14.5"
 
     _commands = [
         "ansible.builtin.command",

src/ansiblelint/rules/no_free_form.py

@@ -31,7 +31,7 @@ class NoFreeFormRule(AnsibleLintRule, TransformMixin):
     description = "Avoid free-form inside files as it can produce subtle bugs."
     severity = "MEDIUM"
     tags = ["syntax", "risk"]
-    version_added = "v6.8.0"
+    version_changed = "6.8.0"
     needs_raw_task = True
     cmd_shell_re = re.compile(
         r"(chdir|creates|executable|removes|stdin|stdin_add_newline|warn)=",

src/ansiblelint/rules/no_handler.py

@@ -63,7 +63,7 @@ class UseHandlerRatherThanWhenChangedRule(AnsibleLintRule):
     link = "https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html#handlers"
     severity = "MEDIUM"
     tags = ["idiom"]
-    version_added = "historic"
+    version_changed = "24.10.0"
 
     def matchtask(
         self,

src/ansiblelint/rules/no_jinja_when.py

@@ -26,7 +26,7 @@ class NoFormattingInWhenRule(AnsibleLintRule, TransformMixin):
     )
     severity = "HIGH"
     tags = ["deprecations"]
-    version_added = "historic"
+    version_changed = "6.20.0"
 
     @staticmethod
     def _is_valid(when: str) -> bool:

src/ansiblelint/rules/no_log_password.py

@@ -44,7 +44,7 @@ class NoLogPasswordsRule(AnsibleLintRule, TransformMixin):
     )
     severity = "LOW"
     tags = ["opt-in", "security", "experimental"]
-    version_added = "v5.0.9"
+    version_changed = "5.0.9"
 
     def matchtask(
         self,

src/ansiblelint/rules/no_prompting.py

@@ -25,7 +25,7 @@ class NoPromptingRule(AnsibleLintRule):
     )
     tags = ["opt-in"]
     severity = "VERY_LOW"
-    version_added = "v6.0.3"
+    version_changed = "6.0.3"
 
     def matchplay(self, file: Lintable, data: dict[str, Any]) -> list[MatchError]:
         """Return matches found for a specific playbook."""

src/ansiblelint/rules/no_relative_paths.py

@@ -22,7 +22,7 @@ class RoleRelativePath(AnsibleLintRule):
     description = "The ``copy`` and ``template`` modules should not use relative path for ``src``."
     severity = "HIGH"
     tags = ["idiom"]
-    version_added = "v4.0.0"
+    version_changed = "4.0.0"
 
     _module_to_path_folder = {
         "copy": "files",

src/ansiblelint/rules/no_same_owner.py

@@ -26,6 +26,7 @@ class NoSameOwnerRule(AnsibleLintRule):
 """
     severity = "LOW"
     tags = ["opt-in"]
+    version_changed = "6.4.0"
 
     def matchtask(
         self,

src/ansiblelint/rules/no_tabs.py

@@ -23,7 +23,7 @@ class NoTabsRule(AnsibleLintRule):
     description = "Tabs can cause unexpected display issues, use spaces"
     severity = "LOW"
     tags = ["formatting"]
-    version_added = "v4.0.0"
+    version_changed = "4.0.0"
     allow_list = [
         ("lineinfile", "insertafter"),
         ("lineinfile", "insertbefore"),

src/ansiblelint/rules/only_builtins.py

@@ -22,6 +22,7 @@ class OnlyBuiltinsRule(AnsibleLintRule):
     severity = "MEDIUM"
     description = "Check whether the playbook uses anything but ``ansible.builtin``"
     tags = ["opt-in", "experimental"]
+    version_changed = "6.14.0"
 
     def matchtask(
         self,

src/ansiblelint/rules/package_latest.py

@@ -40,7 +40,7 @@ class PackageIsNotLatestRule(AnsibleLintRule):
     )
     severity = "VERY_LOW"
     tags = ["idempotency"]
-    version_added = "historic"
+    version_changed = "6.20.0"
 
     _package_managers = [
         "apk",

src/ansiblelint/rules/partial_become.py

@@ -44,7 +44,7 @@ class BecomeUserWithoutBecomeRule(AnsibleLintRule, TransformMixin):
     description = "``become_user`` should have a corresponding ``become`` at the play or task level."
     severity = "VERY_HIGH"
     tags = ["unpredictability"]
-    version_added = "historic"
+    version_changed = "6.20.0"
 
     def matchplay(
         self,