bitwarden_workflow_linter 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

bitwarden_workflow_linter/__about__.py

@@ -1,3 +1,3 @@
 """Metadata for Workflow Linter."""
 
-__version__ = "0.1.0"
+__version__ = "0.2.0"

bitwarden_workflow_linter/actions.py

@@ -11,11 +11,13 @@ from typing import Optional, Union
 
 from .utils import Colors, Settings, Action
 
+
 class GitHubApiSchemaError(Exception):
     """A generic Exception to catch redefinitions of GitHub Api Schema changes."""
 
     pass
 
+
 class ActionsCmd:
     """Command to manage the pre-approved list of Actions
 

bitwarden_workflow_linter/cli.py

@@ -11,6 +11,7 @@ from .utils import Settings
 
 local_settings = Settings.factory()
 
+
 def main(input_args: Optional[List[str]] = None) -> int:
     """CLI utility to lint GitHub Action Workflows.
 
@@ -48,5 +49,6 @@ def main(input_args: Optional[List[str]] = None) -> int:
 
     return -1
 
+
 if __name__ == "__main__":
     sys.exit(main())

bitwarden_workflow_linter/lint.py

@@ -10,6 +10,7 @@ from typing import Optional
 from .load import WorkflowBuilder, Rules
 from .utils import LintFinding, Settings
 
+
 class LinterCmd:
     """Command to lint GitHub Action Workflow files
 

bitwarden_workflow_linter/load.py

@@ -15,11 +15,13 @@ from .utils import Settings
 
 yaml = YAML()
 
+
 class WorkflowBuilderError(Exception):
     """Exception to indicate an error with the WorkflowBuilder."""
 
     pass
 
+
 class WorkflowBuilder:
     """Collection of methods to build Workflow objects."""
 
@@ -82,11 +84,13 @@ class WorkflowBuilder:
             "The workflow must either be built from a file or from a CommentedMap"
         )
 
+
 class LoadRulesError(Exception):
     """Exception to indicate an error with loading rules."""
 
     pass
 
+
 class Rules:
     """A collection of all of the types of rules.
 

bitwarden_workflow_linter/models/job.py

@@ -8,6 +8,7 @@ from ruamel.yaml.comments import CommentedMap
 
 from .step import Step
 
+
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclass
 class Job:

bitwarden_workflow_linter/models/step.py

@@ -6,6 +6,7 @@ from typing import Optional, Self
 from dataclasses_json import config, dataclass_json, Undefined
 from ruamel.yaml.comments import CommentedMap
 
+
 @dataclass_json(undefined=Undefined.EXCLUDE)
 @dataclass
 class Step:

bitwarden_workflow_linter/rule.py

@@ -7,11 +7,13 @@ from .models.job import Job
 from .models.step import Step
 from .utils import LintFinding, LintLevels, Settings
 
+
 class RuleExecutionException(Exception):
     """Exception for the Base Rule class."""
 
     pass
 
+
 class Rule:
     """Base class of a Rule to extend to create a linting Rule."""
 

bitwarden_workflow_linter/rules/job_environment_prefix.py

@@ -6,6 +6,7 @@ from ..models.job import Job
 from ..rule import Rule
 from ..utils import LintLevels, Settings
 
+
 class RuleJobEnvironmentPrefix(Rule):
     """Rule to enforce specific prefixes for environment variables.
 

bitwarden_workflow_linter/rules/name_capitalized.py

@@ -8,6 +8,7 @@ from ..models.workflow import Workflow
 from ..rule import Rule
 from ..utils import LintLevels, Settings
 
+
 class RuleNameCapitalized(Rule):
     """Rule to enforce all 'name' values start with a capital letter.
 
@@ -50,6 +51,12 @@ class RuleNameCapitalized(Rule):
         capitalized names. This Rule DOES NOT enforce that the name exists.
         It only enforces capitalization IF it does.
         """
-        if obj.name:
-            return obj.name[0].isupper(), self.message
-        return True, ""  # Force passing if obj.name doesn't exist
+        if isinstance(obj, Workflow):
+            if obj.name:
+                if obj.name[0] != "_":
+                    return obj.name[0].isupper(), self.message
+        else:
+            if obj.name:
+                return obj.name[0].isupper(), self.message
+
+        return True, ""  # Force passing

bitwarden_workflow_linter/rules/name_exists.py

@@ -8,6 +8,7 @@ from ..models.step import Step
 from ..rule import Rule
 from ..utils import LintLevels, Settings
 
+
 class RuleNameExists(Rule):
     """Rule to enforce a 'name' key exists for every object in GitHub Actions.
 

bitwarden_workflow_linter/rules/pinned_job_runner.py

@@ -6,6 +6,7 @@ from ..models.job import Job
 from ..rule import Rule
 from ..utils import LintLevels, Settings
 
+
 class RuleJobRunnerVersionPinned(Rule):
     """Rule to enforce pinned Runner OS versions.
 

bitwarden_workflow_linter/rules/step_approved.py

@@ -6,6 +6,7 @@ from ..models.step import Step
 from ..rule import Rule
 from ..utils import LintLevels, Settings
 
+
 class RuleStepUsesApproved(Rule):
     """Rule to enforce that all Actions have been pre-approved.
 

bitwarden_workflow_linter/rules/step_pinned.py

@@ -6,6 +6,7 @@ from ..models.step import Step
 from ..rule import Rule
 from ..utils import LintLevels, Settings
 
+
 class RuleStepUsesPinned(Rule):
     """Rule to contain the enforcement logic for pinning Actions versions.
 
@@ -94,4 +95,7 @@ class RuleStepUsesPinned(Rule):
         if len(ref) != 40:
             return False, "Please use the full commit sha to pin the action"
 
+        if not obj.uses_comment:
+            return False, "Please comment the version of the action commit sha"
+
         return True, ""

bitwarden_workflow_linter/rules/underscore_outputs.py

@@ -1,3 +1,5 @@
+""" Rule to enforce all GitHub outputs with more than one words use an underscore."""
+
 import re
 
 from typing import Optional, Union, Tuple
@@ -8,8 +10,9 @@ from ..models.workflow import Workflow
 from ..models.step import Step
 from ..utils import LintLevels, Settings
 
+
 class RuleUnderscoreOutputs(Rule):
-    """Rule to enforce all GitHub 'outputs' more than one words contain an underscore.
+    """Rule to enforce all GitHub outputs with more than one word use an underscore.
 
     A simple standard to ensure uniformity in naming.
     """
@@ -90,7 +93,8 @@ class RuleUnderscoreOutputs(Rule):
                     outputs.extend(obj.on["workflow_dispatch"]["outputs"].keys())
 
             if obj.on.get("workflow_call"):
-                outputs.extend(obj.on["workflow_call"]["outputs"].keys())
+                if obj.on["workflow_call"].get("outputs"):
+                    outputs.extend(obj.on["workflow_call"]["outputs"].keys())
 
         if isinstance(obj, Job):
             if obj.outputs:
@@ -98,9 +102,11 @@ class RuleUnderscoreOutputs(Rule):
 
         if isinstance(obj, Step):
             if obj.run:
-                outputs.extend(re.findall(
-                    r"\b([a-zA-Z0-9_-]+)\s*=\s*[^=]*>>\s*\$GITHUB_OUTPUT",
-                    obj.run))
+                outputs.extend(
+                    re.findall(
+                        r"\b([a-zA-Z0-9_-]+)\s*=\s*[^=]*>>\s*\$GITHUB_OUTPUT", obj.run
+                    )
+                )
 
         for output_name in outputs:
             if "-" in output_name:

bitwarden_workflow_linter/utils.py

@@ -12,6 +12,7 @@ from ruamel.yaml import YAML
 
 yaml = YAML()
 
+
 @dataclass
 class Colors:
     """Class containing color codes for printing strings to output."""
@@ -25,6 +26,7 @@ class Colors:
     cyan = "36m"
     white = "37m"
 
+
 @dataclass
 class LintLevel:
     """Class to contain the numeric level and color of linting."""
@@ -32,6 +34,7 @@ class LintLevel:
     code: int
     color: Colors
 
+
 class LintLevels(LintLevel, Enum):
     """Collection of the different types of LintLevels available."""
 
@@ -39,6 +42,7 @@ class LintLevels(LintLevel, Enum):
     WARNING = 1, Colors.yellow
     ERROR = 2, Colors.red
 
+
 class LintFinding:
     """Represents a problem detected by linting."""
 
@@ -57,6 +61,7 @@ class LintFinding:
             f"{self.description}"
         )
 
+
 @dataclass
 class Action:
     """Collection of the metadata associated with a GitHub Action."""
@@ -93,13 +98,16 @@ class Action:
         """
         return not self.__eq__(other)
 
+
 class SettingsError(Exception):
     """Custom Exception to indicate an error with loading Settings."""
 
     pass
 
+
 SettingsFromFactory = TypeVar("SettingsFromFactory", bound="Settings")
 
+
 class Settings:
     """Class that contains configuration-as-code for any portion of the app."""
 

{bitwarden_workflow_linter-0.1.0.dist-info → bitwarden_workflow_linter-0.2.0.dist-info}/METADATA

@@ -1,10 +1,9 @@
 Metadata-Version: 2.3
 Name: bitwarden_workflow_linter
-Version: 0.1.0
+Version: 0.2.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
-License-File: LICENSE.txt
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3

bitwarden_workflow_linter-0.2.0.dist-info/RECORD

@@ -0,0 +1,27 @@
+bitwarden_workflow_linter/__about__.py,sha256=si3RgiuWR12lqpriKwtC4ny_xoVAWdz9oa4DWW-3QuY,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/load.py,sha256=Ece2bwSSYeQ1xQQEjjqY6DlCkwznFYLG56VW_VTxU4E,4472
+bitwarden_workflow_linter/rule.py,sha256=Qb60JiUDAWN3ayrMGoSbbDCSFmw-ql8djzAkxISaob4,3250
+bitwarden_workflow_linter/utils.py,sha256=9WO3T9w9vKAow_xR6JDz2MvdMXKExV18AzucF0vh67s,4695
+bitwarden_workflow_linter/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bitwarden_workflow_linter/models/job.py,sha256=nBK7_VYu6RRST7WLtdLsoRErl5j4Er8W9hCw9XlSECk,2043
+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/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=s1tySiVCAQOd0-GbKan-bfR6g75WYhf-kiGHin6Iecc,4101
+bitwarden_workflow_linter-0.2.0.dist-info/METADATA,sha256=Ngdn_7McvWBsZdScPnK0oIDaFvq_I9vjw-RCIa1_Sgo,6146
+bitwarden_workflow_linter-0.2.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+bitwarden_workflow_linter-0.2.0.dist-info/entry_points.txt,sha256=SA_yF9CwL4VMUvdcmCd7k9rjsQNzfeOUBuDnMnaO8QQ,60
+bitwarden_workflow_linter-0.2.0.dist-info/licenses/LICENSE.txt,sha256=uY-7N9tbI7xc_c0WeTIGpacSCnsB91N05eCIg3bkaRw,35140
+bitwarden_workflow_linter-0.2.0.dist-info/RECORD,,

{bitwarden_workflow_linter-0.1.0.dist-info → bitwarden_workflow_linter-0.2.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.26.3
 Root-Is-Purelib: true
 Tag: py3-none-any

bitwarden_workflow_linter-0.1.0.dist-info/RECORD

@@ -1,27 +0,0 @@
-bitwarden_workflow_linter/__about__.py,sha256=MXkdpln7M2kqsAFMZY-qjYn8eOBN6pR3T26TyjoZEtI,59
-bitwarden_workflow_linter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bitwarden_workflow_linter/actions.py,sha256=bjuFAP72QHXlDTmMBZffNmSCjZDzyNHGzqEC78ABAgg,7895
-bitwarden_workflow_linter/cli.py,sha256=GABKYWYmcKl4LrA-cgo4ME0mWD4xaO4AgZHBeCCDMy4,1697
-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=Ftz9I3hZS0Vbpn-zk3XKp35Cth3eEo9yf-25rZHrY4k,5460
-bitwarden_workflow_linter/load.py,sha256=E3DPC66rObcmktOKGu3YkGAzWPZLVgSLdZr59DQzz5w,4468
-bitwarden_workflow_linter/rule.py,sha256=H1uwzxck849gh7-kigBgu9RgpJ3lCu3hizQWtZupRJE,3248
-bitwarden_workflow_linter/utils.py,sha256=IyPnxgb91XKXqCifRR5RWEfmZv5F2G9qvwVQVLZd-Bs,4687
-bitwarden_workflow_linter/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bitwarden_workflow_linter/models/job.py,sha256=fkoAC_OV1ekGK40M01iJTtoUJX3Ey6sZWpUTAL5TlSM,2042
-bitwarden_workflow_linter/models/step.py,sha256=C5GNp-pn4GJ0xhAvOKhrFdNYpnCujxGOzKtpACaV5Xg,1710
-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=lAjvnn2PU1uVyHKRtJiehHmPHfQVaMNY-MLPPRuFvoY,2414
-bitwarden_workflow_linter/rules/name_capitalized.py,sha256=VlxPpM82-vg2PlJGU5GWzdamYaz8DJ_AWuMgYzHNgsQ,1751
-bitwarden_workflow_linter/rules/name_exists.py,sha256=eEPtU5y5T0aRQrICdiW1vju1Ny31VUCh_gOf6C6yFSI,1680
-bitwarden_workflow_linter/rules/pinned_job_runner.py,sha256=hg8R6JDAAAhoiEgA9ihWhwLznIicbSw0knJvYI1TYEI,1605
-bitwarden_workflow_linter/rules/step_approved.py,sha256=KhQTmqLkYjwZRZHspUwPBWXy1DExLoOQLp3sEoGM9qI,3306
-bitwarden_workflow_linter/rules/step_pinned.py,sha256=BBCSbC-XyeB_ZILtA1q59NOB3IbY1QY8qpYt_gQ4YvM,3285
-bitwarden_workflow_linter/rules/underscore_outputs.py,sha256=A-EDU_0uexQEwzjg5bwgqkPQInI-hVYRqCNX-BTRXL4,3909
-bitwarden_workflow_linter-0.1.0.dist-info/METADATA,sha256=m97phO-mQ9T2UwYjM9u0tgusHpuka825k6OVBreN9K4,6172
-bitwarden_workflow_linter-0.1.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bitwarden_workflow_linter-0.1.0.dist-info/entry_points.txt,sha256=SA_yF9CwL4VMUvdcmCd7k9rjsQNzfeOUBuDnMnaO8QQ,60
-bitwarden_workflow_linter-0.1.0.dist-info/licenses/LICENSE.txt,sha256=uY-7N9tbI7xc_c0WeTIGpacSCnsB91N05eCIg3bkaRw,35140
-bitwarden_workflow_linter-0.1.0.dist-info/RECORD,,