Updaing help validator to reflect troubleshooting change

rapid7 · Jan 6, 2025 · bf6c058 · bf6c058
1 parent c82db17
commit bf6c058
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -61,7 +61,7 @@ run `pre-commit install` in the repository after cloning and you will
 be on your way to contributing!
 
 ## Changelog
-
+* 2.47.24 - `HelpInputOutputValidator` - Reflect `troubleshooting` changing datatype to List. Now expected as `# Troubleshooting`
 * 2.47.23 - `RegenerationValidator` - Show file names of mismatched checksums
 * 2.47.22 - `VersionBumpValidator` - Skipping remote validation for newly created local plugins
 * 2.47.21 - `RuntimeValidator` - Fixed issue where validator failed if plugin contained a cache files

diff --git a/icon_validator/__init__.py b/icon_validator/__init__.py
@@ -1 +1 @@
-VERSION = "2.47.23"
+VERSION = "2.47.24"
diff --git a/icon_validator/rules/plugin_validators/help_validator.py b/icon_validator/rules/plugin_validators/help_validator.py
@@ -16,7 +16,7 @@ class HelpValidator(KomandPluginValidator):
         "## Technical Details",
         "### Actions",
         "### Triggers",
-        "## Troubleshooting",
+        "# Troubleshooting",
         "# Version History",
         "# Links",
         "## References",

diff --git a/icon_validator/rules/workflow_validators/workflow_help_validator.py b/icon_validator/rules/workflow_validators/workflow_help_validator.py
@@ -38,8 +38,8 @@ def validate_help_headers(help_str):
             raise ValidationException("Help section is missing header: ## Setup.")
         if "## Technical Details" not in help_str:
             raise ValidationException("Help section is missing header: ## Technical Details.")
-        if "## Troubleshooting" not in help_str:
-            raise ValidationException("Help section is missing header: ## Troubleshooting.")
+        if "# Troubleshooting" not in help_str:
+            raise ValidationException("Help section is missing header: # Troubleshooting.")
         if "# Version History" not in help_str:
             raise ValidationException("Help section is missing header: # Version History.")
         if "# Links" not in help_str: