bitwarden_workflow_linter 0.1.1__py3-none-any.whl → 0.2.1__py3-none-any.whl

bitwarden_workflow_linter/__about__.py

@@ -1,3 +1,3 @@
 """Metadata for Workflow Linter."""
 
-__version__ = "0.1.1"
+__version__ = "0.2.1"

bitwarden_workflow_linter/default_settings.yaml

@@ -4,6 +4,7 @@ enabled_rules:
   - bitwarden_workflow_linter.rules.pinned_job_runner.RuleJobRunnerVersionPinned
   - bitwarden_workflow_linter.rules.job_environment_prefix.RuleJobEnvironmentPrefix
   - bitwarden_workflow_linter.rules.step_pinned.RuleStepUsesPinned
+  - bitwarden_workflow_linter.rules.step_pinned.RuleStepUsesPinned
   - bitwarden_workflow_linter.rules.underscore_outputs.RuleUnderscoreOutputs
 
 approved_actions_path: default_actions.json

bitwarden_workflow_linter/lint.py

@@ -54,6 +54,7 @@ class LinterCmd:
         )
         parser_lint.add_argument("-f", "--files", action="append", help="files to lint")
         parser_lint.add_argument(
+            "-o",
             "--output",
             action="store",
             help="output format: [stdout|json|md]",
@@ -137,9 +138,10 @@ class LinterCmd:
             if os.path.isfile(path):
                 workflow_files.append(path)
             elif os.path.isdir(path):
-                for subdir, _, files in os.walk(path):
-                    for filename in files:
-                        filepath = subdir + os.sep + filename
+                for dirpath, dirnames, filenames in os.walk(path):
+                    dirnames[:] = []
+                    for file in filenames:
+                        filepath = dirpath + os.sep + file
                         if filepath.endswith((".yml", ".yaml")):
                             workflow_files.append(filepath)
 

bitwarden_workflow_linter/rules/job_environment_prefix.py

@@ -58,11 +58,12 @@ class RuleJobEnvironmentPrefix(Rule):
         incorrectly named environment variables.
         """
         correct = True
+        allowed_envs = {"NODE_OPTION", "NUGET_PACKAGES", "MINT_PATH", "MINT_LINK_PATH"}
 
         if obj.env:
             offending_keys = []
             for key in obj.env.keys():
-                if key[0] != "_":
+                if key not in allowed_envs and key[0] != "_":
                     offending_keys.append(key)
                     correct = False
 

bitwarden_workflow_linter/rules/step_approved.py

@@ -41,8 +41,8 @@ class RuleStepUsesApproved(Rule):
         if "@" not in obj.uses:
             return True
 
-        ## Force pass for any bitwarden/gh-actions
-        if obj.uses.startswith("bitwarden/gh-actions"):
+        ## Force pass for any bitwarden/
+        if obj.uses.startswith("bitwarden/"):
             return True
 
         return False

bitwarden_workflow_linter/rules/step_pinned.py

@@ -82,7 +82,7 @@ class RuleStepUsesPinned(Rule):
 
         path, ref = obj.uses.split("@")
 
-        if path.startswith("bitwarden/gh-actions"):
+        if path.startswith("bitwarden/"):
             if ref == "main":
                 return True, ""
             return False, "Please pin to main"

bitwarden_workflow_linter/rules/underscore_outputs.py

@@ -25,7 +25,7 @@ class RuleUnderscoreOutputs(Rule):
             A Settings object that contains any default, overridden, or custom settings
             required anywhere in the application.
         """
-        self.message = "outputs with more than one word must use an underscore"
+        self.message = "outputs with more than one word should use an underscore"
         self.on_fail = LintLevels.WARNING
         self.compatibility = [Workflow, Job, Step]
         self.settings = settings
@@ -90,14 +90,18 @@ class RuleUnderscoreOutputs(Rule):
         if isinstance(obj, Workflow):
             if obj.on.get("workflow_dispatch"):
                 if obj.on["workflow_dispatch"].get("outputs"):
-                    outputs.extend(obj.on["workflow_dispatch"]["outputs"].keys())
+                    for output, _ in obj.on["workflow_dispatch"]["outputs"].items():
+                        outputs.append(output)
 
             if obj.on.get("workflow_call"):
-                outputs.extend(obj.on["workflow_call"]["outputs"].keys())
+                if obj.on["workflow_call"].get("outputs"):
+                    for output, _ in obj.on["workflow_call"]["outputs"].items():
+                        outputs.append(output)
 
         if isinstance(obj, Job):
             if obj.outputs:
-                outputs.extend(obj.outputs.keys())
+                for output in obj.outputs.keys():
+                    outputs.append(output)
 
         if isinstance(obj, Step):
             if obj.run:
@@ -107,10 +111,18 @@ class RuleUnderscoreOutputs(Rule):
                     )
                 )
 
-        for output_name in outputs:
-            if "-" in output_name:
-                return False, (
-                    f"Hyphen found in {obj.__class__.__name__} output: {output_name}"
-                )
+        correct = True
+        offending_keys = []
+
+        for name in outputs:
+            if "-" in name:
+                offending_keys.append(name)
+                correct = False
+
+        if correct:
+            return True, ""
 
-        return True, ""
+        return (
+            False,
+            f"{obj.__class__.__name__} {self.message}: ({' ,'.join(offending_keys)})",
+        )

{bitwarden_workflow_linter-0.1.1.dist-info → bitwarden_workflow_linter-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bitwarden_workflow_linter
-Version: 0.1.1
+Version: 0.2.1
 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.1.1.dist-info → bitwarden_workflow_linter-0.2.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
-bitwarden_workflow_linter/__about__.py,sha256=Br2wbEH77faRQss7FPgEVwhkk8WUvso0tqG1LhHtZzE,59
+bitwarden_workflow_linter/__about__.py,sha256=i7sjN4kIit1ye9XdGItqGi91cWiWv11IUmljOfGbykA,59
 bitwarden_workflow_linter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bitwarden_workflow_linter/actions.py,sha256=daob3be2Y22gfsAmGhTgBRCgGk18mlGduqc5Zn1Onz4,7897
 bitwarden_workflow_linter/cli.py,sha256=wgkK1MlVbo6Zx3f2CZZ_tkSWq_hdsGciHJA1knX6Yuw,1699
 bitwarden_workflow_linter/default_actions.json,sha256=BeFllnAu9v6cX6eeGeNoQf3rXs7ZOjAtjTNBQuAZ8-k,8087
-bitwarden_workflow_linter/default_settings.yaml,sha256=EMKRFPFlbgkWtZGUA10Y758RJfAjuI8IUDeqRnRTTs8,505
-bitwarden_workflow_linter/lint.py,sha256=z83h7XOnULngPqTwlo5LKCK2ciUu4oalwixKVcFLWac,5461
+bitwarden_workflow_linter/default_settings.yaml,sha256=lgIKpirGuxRa06QCOxalPP9H-aObYhXFryrHkEKQNM0,572
+bitwarden_workflow_linter/lint.py,sha256=RDHv5jGeGCf5XIHE8jyqQET3-cFykl7223SQVS4Q3pg,5525
 bitwarden_workflow_linter/load.py,sha256=Ece2bwSSYeQ1xQQEjjqY6DlCkwznFYLG56VW_VTxU4E,4472
 bitwarden_workflow_linter/rule.py,sha256=Qb60JiUDAWN3ayrMGoSbbDCSFmw-ql8djzAkxISaob4,3250
 bitwarden_workflow_linter/utils.py,sha256=9WO3T9w9vKAow_xR6JDz2MvdMXKExV18AzucF0vh67s,4695
@@ -13,15 +13,15 @@ bitwarden_workflow_linter/models/job.py,sha256=nBK7_VYu6RRST7WLtdLsoRErl5j4Er8W9
 bitwarden_workflow_linter/models/step.py,sha256=1bKAtKZmHcO8O1e_HuoXxR1bwHDEXUssYo7EHOjY7QI,1711
 bitwarden_workflow_linter/models/workflow.py,sha256=MkqvIY4JX2eWFODNTodS_l4I8uUq08WCHy3C4kYcL0s,1395
 bitwarden_workflow_linter/rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bitwarden_workflow_linter/rules/job_environment_prefix.py,sha256=QCYNj-sX5VB5v49OkBdmFGDkm1E2ebcfiAvlkDVNx7g,2415
+bitwarden_workflow_linter/rules/job_environment_prefix.py,sha256=HJeZhw1JVk4PTYZUY8C2j9wG5x5SqaNy_6WHHlZ_iM4,2531
 bitwarden_workflow_linter/rules/name_capitalized.py,sha256=XwRZ33OeQv_i7z_2Yf7TEgJNodOl5byXfegqfmhaTYQ,1914
 bitwarden_workflow_linter/rules/name_exists.py,sha256=MxcaNQz64JXeHRPiOip9BxJNgPdpKQa7Z51mDoNw2hU,1681
 bitwarden_workflow_linter/rules/pinned_job_runner.py,sha256=Dm6_sdPX0yFMji_y2LMFj4gWFaToEgauyBVpNRP2qiI,1606
-bitwarden_workflow_linter/rules/step_approved.py,sha256=UIi9_z9j75SpQUmo29MLDhjLklqd4h0D-UYqkdcaju0,3307
-bitwarden_workflow_linter/rules/step_pinned.py,sha256=e9yhbo9wsz7CDj1s4fGEsktA8B9YarzE26R_zmNLs7M,3400
-bitwarden_workflow_linter/rules/underscore_outputs.py,sha256=iYmpU2perfV5a8iIEaMneRvAx6YJUNj8Zu7WSa63fTU,4038
-bitwarden_workflow_linter-0.1.1.dist-info/METADATA,sha256=rPOTaa6sgBn-UydvFWU3LNGq2E3cdbUGUB6EBm5zPLU,6146
-bitwarden_workflow_linter-0.1.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-bitwarden_workflow_linter-0.1.1.dist-info/entry_points.txt,sha256=SA_yF9CwL4VMUvdcmCd7k9rjsQNzfeOUBuDnMnaO8QQ,60
-bitwarden_workflow_linter-0.1.1.dist-info/licenses/LICENSE.txt,sha256=uY-7N9tbI7xc_c0WeTIGpacSCnsB91N05eCIg3bkaRw,35140
-bitwarden_workflow_linter-0.1.1.dist-info/RECORD,,
+bitwarden_workflow_linter/rules/step_approved.py,sha256=xZE9x40P-C4SqOxjYN3ZHR4gxWSkYJFEfYwEzA2c05w,3287
+bitwarden_workflow_linter/rules/step_pinned.py,sha256=CSHbyeLx1uT8exRzOgFVc1dzMJGnbXhTHiteaoOLWUk,3390
+bitwarden_workflow_linter/rules/underscore_outputs.py,sha256=johfE2Qwb_ww4xbW5u-ug37wNZbHZgKdRYg339cxUR8,4381
+bitwarden_workflow_linter-0.2.1.dist-info/METADATA,sha256=-2gvyfTfmDQrjtDMT1kwxuISDAvoikpJkXj611PdvSI,6146
+bitwarden_workflow_linter-0.2.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+bitwarden_workflow_linter-0.2.1.dist-info/entry_points.txt,sha256=SA_yF9CwL4VMUvdcmCd7k9rjsQNzfeOUBuDnMnaO8QQ,60
+bitwarden_workflow_linter-0.2.1.dist-info/licenses/LICENSE.txt,sha256=uY-7N9tbI7xc_c0WeTIGpacSCnsB91N05eCIg3bkaRw,35140
+bitwarden_workflow_linter-0.2.1.dist-info/RECORD,,