Add actionlint to workflow linter

settings.yaml

@@ -6,5 +6,6 @@ enabled_rules:
   - bitwarden_workflow_linter.rules.step_approved.RuleStepUsesApproved
   - bitwarden_workflow_linter.rules.step_pinned.RuleStepUsesPinned
   - bitwarden_workflow_linter.rules.underscore_outputs.RuleUnderscoreOutputs
+  - bitwarden_workflow_linter.rules.run_actionlint.RunActionlint
 
 approved_actions_path: default_actions.json

src/bitwarden_workflow_linter/default_settings.yaml

@@ -6,5 +6,6 @@ enabled_rules:
   - bitwarden_workflow_linter.rules.step_approved.RuleStepUsesApproved
   - bitwarden_workflow_linter.rules.step_pinned.RuleStepUsesPinned
   - bitwarden_workflow_linter.rules.underscore_outputs.RuleUnderscoreOutputs
+  - bitwarden_workflow_linter.rules.run_actionlint.RunActionlint
 
 approved_actions_path: default_actions.json

src/bitwarden_workflow_linter/rules/run_actionlint.py

@@ -0,0 +1,69 @@
+"""A Rule to run actionlint on workflows."""
+
+from typing import Optional, Tuple
+import subprocess
+import platform
+
+from ..rule import Rule
+from ..models.job import Job
+from ..models.workflow import Workflow
+from ..utils import LintLevels, Settings
+
+
+def check_actionlint():
+    """Check if the actionlint is in the system's PATH.
+
+    If actionlint is not installed, detects OS platform 
+    and installs actionlint
+    """
+    Platform = platform.system()
+    try:
+        subprocess.run(["actionlint", '--version'], stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True)
+        return True
+    except subprocess.CalledProcessError:
+        return False
+    except FileNotFoundError:
+        if Platform.startswith('Linux'):
+            try:
+                subprocess.run(['sudo', 'apt-get', 'install', '-y', 'actionlint'], check=True)
+                return True
+            except subprocess.CalledProcessError:
+                print(f"Failed to install Actionlint. Please check your package manager or manually install it.")
+                return False
+        elif Platform == 'Darwin':
+            try:
+                subprocess.run(['brew', 'install', 'actionlint'], check=True)
+                return True
+            except subprocess.CalledProcessError:
+                print(f"Failed to install Actionlint. Please check your Homebrew installation or manually install it.")
+                return False
+        elif Platform == 'Win32':
+            try:
+                subprocess.run(['choco', 'install', 'actionlint', '-y'], check=True)
+                return True
+            except subprocess.CalledProcessError:
+                print(f"Failed to install Actionlint. Please check your Chocolatey installation or manually install it.")
+                return False
+
+class RunActionlint(Rule):
+    """Rule to run actionlint as part of workflow linter V2.
+    """
+
+    def __init__(self, settings: Optional[Settings] = None) -> None:
+        self.message = "Actionlint must pass without errors"
+        self.on_fail = LintLevels.WARNING
+        self.compatibility = [Workflow]
+        self.settings = settings
+
+    def fn(self, obj: Job) -> Tuple[bool, str]:
+        if check_actionlint():
+            result = subprocess.run(["actionlint"], capture_output=True, text=True)
+            if result.returncode == 1:
+                print(result.stdout)
+                return False, self.message
+            elif result.returncode > 1:
+                return False, result.stderr
+            return True, ""
+        else:
+            print(f"Actionlint could not be installed.")
+            return False, ""