bitwarden_workflow_linter 0.12.8__py3-none-any.whl → 0.13.0__py3-none-any.whl

bitwarden_workflow_linter/__about__.py

@@ -1,3 +1,3 @@
 """Metadata for Workflow Linter."""
 
-__version__ = "0.12.8"
+__version__ = "0.13.0"

bitwarden_workflow_linter/actionlint_version.yaml

@@ -0,0 +1 @@
+actionlint_version: "1.7.7"

bitwarden_workflow_linter/rules/run_actionlint.py

@@ -5,21 +5,20 @@ import subprocess
 import platform
 import urllib.request
 import os
-import json
 
 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)
@@ -34,20 +33,8 @@ def install_actionlint(platform_system: str) -> Tuple[bool, str]:
             return False, f"{error} : check Choco installation"
     return False, error
 
-# temporarily commenting out this logic to allow time to troubleshoot it running in CI
-# def load_config() -> dict:
-#     """Load configuration from a JSON file."""
-#     config_path = os.path.join(os.path.dirname(__file__), "../../../actionlint_version.json")
-#     if not os.path.exists(config_path):
-#         raise FileNotFoundError(f"Configuration file not found: {config_path}")
-#     with open(config_path, "r") as config_file:
-#         return json.load(config_file)
-
-def install_actionlint_source(error) -> Tuple[bool, str]:
-    #config = load_config()
-    #if "actionlint_version" not in config:
-    #    raise KeyError("The 'actionlint_version' is missing in the configuration file.")
-    version = "1.7.7"
+def install_actionlint_source(error, version) -> Tuple[bool, str]:
+    version = version
     """Install Actionlint Binary from provided script"""
     url = "https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash"
     request = urllib.request.urlopen(url)
@@ -60,7 +47,7 @@ def install_actionlint_source(error) -> Tuple[bool, str]:
         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(
@@ -77,7 +64,7 @@ def check_actionlint(platform_system: str) -> Tuple[bool, str]:
 please check your package installer or manually install it",
         )
     except FileNotFoundError:
-        return install_actionlint(platform_system)
+        return install_actionlint(platform_system, version)
 
 
 class RunActionlint(Rule):
@@ -95,7 +82,8 @@ class RunActionlint(Rule):
                 "Running actionlint without a filename is not currently supported"
             )
 
-        installed, location = check_actionlint(platform.system())
+        """Check if Actionlint is alerady installed and if it is installed somewhere not on the PATH (location)"""
+        installed, location = check_actionlint(platform.system(), self.settings.actionlint_version)
         if installed:
             if location:
                 result = subprocess.run(

bitwarden_workflow_linter/utils.py

@@ -107,17 +107,18 @@ class SettingsError(Exception):
 
 SettingsFromFactory = TypeVar("SettingsFromFactory", bound="Settings")
 
-
 class Settings:
     """Class that contains configuration-as-code for any portion of the app."""
 
     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.
 
@@ -134,7 +135,11 @@ class Settings:
 
         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()
@@ -142,6 +147,7 @@ class Settings:
 
     @staticmethod
     def factory() -> SettingsFromFactory:
+        # load default settings
         with (
             importlib.resources.files("bitwarden_workflow_linter")
             .joinpath("default_settings.yaml")
@@ -149,6 +155,16 @@ class Settings:
         ):
             settings = yaml.load(file)
 
+        # load actionlint version
+        with (
+            importlib.resources.files("bitwarden_workflow_linter")
+            .joinpath("actionlint_version.yaml")
+            .open("r", encoding="utf-8") as version_file
+        ):
+            version_data = yaml.load(version_file)
+            actionlint_version = version_data["actionlint_version"]
+
+        # load override settings
         settings_filename = "settings.yaml"
         local_settings = None
 
@@ -159,6 +175,7 @@ class Settings:
         if local_settings:
             settings.update(local_settings)
 
+        # load approved actions
         if settings["approved_actions_path"] == "default_actions.json":
             with (
                 importlib.resources.files("bitwarden_workflow_linter")
@@ -172,7 +189,9 @@ class Settings:
             ) as action_file:
                 settings["approved_actions"] = json.load(action_file)
 
+        
         return Settings(
             enabled_rules=settings["enabled_rules"],
             approved_actions=settings["approved_actions"],
+            actionlint_version=actionlint_version,
         )

{bitwarden_workflow_linter-0.12.8.dist-info → bitwarden_workflow_linter-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bitwarden_workflow_linter
-Version: 0.12.8
+Version: 0.13.0
 Summary: Custom GitHub Action Workflow Linter
 Project-URL: Homepage, https://github.com/bitwarden/workflow-linter
 Project-URL: Issues, https://github.com/bitwarden/workflow-linter/issues

{bitwarden_workflow_linter-0.12.8.dist-info → bitwarden_workflow_linter-0.13.0.dist-info}/RECORD

@@ -1,5 +1,6 @@
-bitwarden_workflow_linter/__about__.py,sha256=ZdiLjVTeeNrx0AR16pNVu_PRw8OcIOjX0zmGPDveJq8,60
+bitwarden_workflow_linter/__about__.py,sha256=f5QTzIvY76oCTstHg8y_8_yGGrjcJvuwpeka56B-4eM,60
 bitwarden_workflow_linter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bitwarden_workflow_linter/actionlint_version.yaml,sha256=CKhiDwaDBNCExOHTlcpiavfEgf01uG_tTPrgLRaj6_k,28
 bitwarden_workflow_linter/actions.py,sha256=LAn3yQeMMmCOvJWeTn3dE1U2nyEJqIBMwESq3TtY9hE,9069
 bitwarden_workflow_linter/cli.py,sha256=wgkK1MlVbo6Zx3f2CZZ_tkSWq_hdsGciHJA1knX6Yuw,1699
 bitwarden_workflow_linter/default_actions.json,sha256=gmjTUnLl1QpovMt5siNxP-qGkSNmXMSRvt4Ud1jne4c,13523
@@ -7,7 +8,7 @@ bitwarden_workflow_linter/default_settings.yaml,sha256=XCaRFqdJ_lbNUDlPthySZzF0d
 bitwarden_workflow_linter/lint.py,sha256=R0dXkwir0KzXFHWfWlqpH_CyBwa7O8wHSBTy560u94g,6322
 bitwarden_workflow_linter/load.py,sha256=FWxotIlB0vyKzrVw87sOx3qdRiJG_0hVHRbbLXZY4Sc,5553
 bitwarden_workflow_linter/rule.py,sha256=Qb60JiUDAWN3ayrMGoSbbDCSFmw-ql8djzAkxISaob4,3250
-bitwarden_workflow_linter/utils.py,sha256=wMrq5_gAprbGYPdwbn8fL316aeVG2rGEDV1I7NMl4LE,4717
+bitwarden_workflow_linter/utils.py,sha256=8FhDq71kOWqoN61H9Iy10HrFSbdaSjb6QlpjPR8YhQ0,5441
 bitwarden_workflow_linter/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bitwarden_workflow_linter/models/job.py,sha256=d4F0QG35DqaqgfbPa2YDRRxOZZakFDktIOsuUa-BbC8,2387
 bitwarden_workflow_linter/models/step.py,sha256=j81iWYWcNI9x55n1MOR0N6ogKaQ_4-CKu9LnI_fwEOE,1814
@@ -19,12 +20,12 @@ bitwarden_workflow_linter/rules/name_capitalized.py,sha256=lGHPi_Ix0DVSzGEdrUm2v
 bitwarden_workflow_linter/rules/name_exists.py,sha256=kdMIURN3u8qdDvw6YKxg7VF5bkzGxVVXAO3KAqY1-54,1826
 bitwarden_workflow_linter/rules/permissions_exist.py,sha256=_qOonJ0tyIH3Wp0e-0cppyVIbY9Sr7DuZPZdwxjYMaI,1432
 bitwarden_workflow_linter/rules/pinned_job_runner.py,sha256=VPQfMu3SgIFdl-B8wOXzzK6tMx2hWWSJbKL5KG3xcaI,1751
-bitwarden_workflow_linter/rules/run_actionlint.py,sha256=025XHDTtA0mhYgDK6jf4epEPDAXOoinfDd424NAbGiw,4454
+bitwarden_workflow_linter/rules/run_actionlint.py,sha256=8ovmccFiWtqLJNE1_QO3rKgmnL8ss4dbnq1SC3t2OX4,4007
 bitwarden_workflow_linter/rules/step_approved.py,sha256=4pUCrOlWomo43bwGBunORphv1RJzc3spRKgZ4VLtDS0,3304
 bitwarden_workflow_linter/rules/step_pinned.py,sha256=MagV8LNdgRKyncmSdH9V-TlIcsdjzoDHDWqovzWon9E,3559
 bitwarden_workflow_linter/rules/underscore_outputs.py,sha256=LoCsDN_EfQ8H9n5BfZ5xCe7BeHqJGPMcV0vo1c9YJcw,4275
-bitwarden_workflow_linter-0.12.8.dist-info/METADATA,sha256=OGWJX_5ZqltNcEOvmqnTIzlABjhfPsHjX4OzpfnBo6k,9797
-bitwarden_workflow_linter-0.12.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-bitwarden_workflow_linter-0.12.8.dist-info/entry_points.txt,sha256=SA_yF9CwL4VMUvdcmCd7k9rjsQNzfeOUBuDnMnaO8QQ,60
-bitwarden_workflow_linter-0.12.8.dist-info/licenses/LICENSE.txt,sha256=uY-7N9tbI7xc_c0WeTIGpacSCnsB91N05eCIg3bkaRw,35140
-bitwarden_workflow_linter-0.12.8.dist-info/RECORD,,
+bitwarden_workflow_linter-0.13.0.dist-info/METADATA,sha256=yYyaD29hRHP4Uuey5Idv-C-IsCCTylTpBs5AcMJwMNw,9797
+bitwarden_workflow_linter-0.13.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bitwarden_workflow_linter-0.13.0.dist-info/entry_points.txt,sha256=SA_yF9CwL4VMUvdcmCd7k9rjsQNzfeOUBuDnMnaO8QQ,60
+bitwarden_workflow_linter-0.13.0.dist-info/licenses/LICENSE.txt,sha256=uY-7N9tbI7xc_c0WeTIGpacSCnsB91N05eCIg3bkaRw,35140
+bitwarden_workflow_linter-0.13.0.dist-info/RECORD,,