Agalles/renovate actionlint v2

.github/workflows/actionlint_windows.yml

@@ -0,0 +1,35 @@
+name: Test Actionlint on Windows
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "**/run_actionlint.py"
+      - "**/default_actions.json"
+      - "**/actionlint_windows.yml"
+
+jobs:
+  test:
+    name: Windows workflow-linter (v2)
+    runs-on: windows-2022
+    steps:
+        - name: Check out repo
+          uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+        - name: Set up Python
+          uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
+          with:
+            python-version-file: ".python-version"
+
+        - name: Install dependencies
+          run: |
+            python -m pip install --upgrade pip
+            pip install pipenv
+            pipenv install --dev
+
+        - name: Install bwwl binary
+          run: python -m pip install --upgrade .
+
+        - name: Lint
+          run: bwwl lint -f .github/workflows

Pipfile

@@ -16,7 +16,7 @@ pytest = "*"
 coverage = "*"
 pytest-cov = "*"
 pylint = "*"
-pytype = "*"
+pytype = {version = "*", sys_platform = "!= 'win32'"}
 hatchling = "*"
 build = "*"
 

src/bitwarden_workflow_linter/default_settings.yaml

@@ -19,3 +19,5 @@ enabled_rules:
     level: warning
 
 approved_actions_path: default_actions.json
+
+actionlint_version: "1.7.7"

src/bitwarden_workflow_linter/rules/run_actionlint.py

@@ -4,69 +4,76 @@
 import subprocess
 import platform
 import urllib.request
-import os
 
 from ..rule import Rule
 from ..models.workflow import Workflow
 from ..utils import LintLevels, Settings
 
 
-def install_actionlint(platform_system: str) -> Tuple[bool, str]:
+def install_actionlint(platform_system: str, version: str) -> Tuple[bool, str]:
     """If actionlint is not installed, detects OS platform
     and installs actionlint"""
 
     error = f"An error occurred when installing Actionlint on {platform_system}"
-
     if platform_system.startswith("Linux"):
-        return install_actionlint_source(error)
+        return install_actionlint_source(error, version)
     elif platform_system == "Darwin":
-        try:
-            subprocess.run(["brew", "install", "actionlint"], check=True)
-            return True, ""
-        except (FileNotFoundError, subprocess.CalledProcessError):
-            return False, f"{error} : check Brew installation"
+        return install_actionlint_source(error, version) # Homebrew does not maintain previous versions of Actionlint
     elif platform_system.startswith("Win"):
         try:
-            subprocess.run(["choco", "install", "actionlint", "-y"], check=True)
+            subprocess.run(["choco", "install", "actionlint", "-y", f"--version='{version}'"], check=True)
             return True, ""
         except (FileNotFoundError, subprocess.CalledProcessError):
             return False, f"{error} : check Choco installation"
     return False, error
 
-
-def install_actionlint_source(error) -> Tuple[bool, str]:
+def install_actionlint_source(error, version) -> Tuple[bool, str]:
     """Install Actionlint Binary from provided script"""
     url = "https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash"
-    version = "1.6.17"
+    version = version
     request = urllib.request.urlopen(url)
     with open("download-actionlint.bash", "wb+") as fp:
         fp.write(request.read())
     try:
         subprocess.run(["bash", "download-actionlint.bash", version], check=True)
-        return True, os.getcwd()
+        return True, "./actionlint"
     except (FileNotFoundError, subprocess.CalledProcessError):
         return False, error
 
-
-def check_actionlint(platform_system: str) -> Tuple[bool, str]:
+def check_actionlint(platform_system: str, version: str) -> Tuple[bool, str]:
     """Check if the actionlint is in the system's PATH."""
     try:
-        subprocess.run(
+        installed = subprocess.run(
             ["actionlint", "--version"],
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
             check=True,
-        )
-        return True, ""
+            )
+        if version in f"{installed}":
+            return True, ""
+        else:
+            return install_actionlint(platform_system, version)
+
     except subprocess.CalledProcessError:
         return (
             False,
             "Failed to install Actionlint, \
 please check your package installer or manually install it",
         )
     except FileNotFoundError:
-        return install_actionlint(platform_system)
-
+        try:
+            installed = subprocess.run(
+            ["./actionlint", "--version"],
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            check=True,
+            )
+            if version in f"{installed}":
+                return True, "./actionlint"
+            else:
+                return install_actionlint(platform_system, version)
+        except FileNotFoundError:
+                return install_actionlint(platform_system, version)
 
 class RunActionlint(Rule):
     """Rule to run actionlint as part of workflow linter V2."""
@@ -83,11 +90,11 @@ def fn(self, obj: Workflow) -> Tuple[bool, str]:
                 "Running actionlint without a filename is not currently supported"
             )
 
-        installed, location = check_actionlint(platform.system())
+        installed, location = check_actionlint(platform.system(), self.settings.actionlint_version)
         if installed:
             if location:
                 result = subprocess.run(
-                    [location + "/actionlint", obj.filename],
+                    [location, obj.filename],
                     capture_output=True,
                     text=True,
                     check=False,

src/bitwarden_workflow_linter/utils.py

@@ -113,11 +113,13 @@ class Settings:
 
     enabled_rules: list[dict[str, str]]
     approved_actions: dict[str, Action]
+    actionlint_version = str
 
     def __init__(
         self,
         enabled_rules: Optional[list[dict[str, str]]] = None,
         approved_actions: Optional[dict[str, dict[str, str]]] = None,
+        actionlint_version: Optional[str] = None,
     ) -> None:
         """Settings object that can be overridden in settings.py.
 
@@ -135,6 +137,10 @@ def __init__(
         if approved_actions is None:
             approved_actions = {}
 
+        if actionlint_version is None:
+            actionlint_version = ""
+
+        self.actionlint_version = actionlint_version
         self.enabled_rules = enabled_rules
         self.approved_actions = {
             name: Action(**action) for name, action in approved_actions.items()
@@ -175,4 +181,5 @@ def factory() -> SettingsFromFactory:
         return Settings(
             enabled_rules=settings["enabled_rules"],
             approved_actions=settings["approved_actions"],
+            actionlint_version=settings["actionlint_version"],
         )