RepoAuditor 0.2.43__tar.gz → 0.2.45__tar.gz

{repoauditor-0.2.43 → repoauditor-0.2.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.43
+Version: 0.2.45
 Summary: Add your description here
 Project-URL: Homepage, https://github.com/gt-sse-center/RepoAuditor
 Project-URL: Documentation, https://github.com/gt-sse-center/RepoAuditor
@@ -73,6 +73,11 @@ To get a list of command line options, you can run
 uv run repo_auditor --help
 ```
 
+`RepoAuditor` accepts both a set of flags as well as a configuratin YAML file. We have provided a sample configuration file called `default_config.yaml`, which can be used as:
+```shell
+uv run repo_auditor --config default_config.yaml
+```
+
 ### Personal Access Token (PAT)
 
 The most common use case for `RepoAuditor` would be to audit a GitHub repository.

{repoauditor-0.2.43 → repoauditor-0.2.45}/README.md

@@ -46,6 +46,11 @@ To get a list of command line options, you can run
 uv run repo_auditor --help
 ```
 
+`RepoAuditor` accepts both a set of flags as well as a configuratin YAML file. We have provided a sample configuration file called `default_config.yaml`, which can be used as:
+```shell
+uv run repo_auditor --config default_config.yaml
+```
+
 ### Personal Access Token (PAT)
 
 The most common use case for `RepoAuditor` would be to audit a GitHub repository.

repoauditor-0.2.45/default_config.yaml

@@ -0,0 +1,5 @@
+includes: ["GitHub", "GitHubCommunityStandards", "GitHubRulesets"]
+GitHub-url: "https://github.com/gt-sse-center/RepoAuditor"
+GitHubCommunityStandards-url: "https://github.com/gt-sse-center/RepoAuditor"
+GitHubRulesets-url: "https://github.com/gt-sse-center/RepoAuditor"
+# GitHub-pat: "PAT"

{repoauditor-0.2.43 → repoauditor-0.2.45}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionQuery.py

@@ -39,7 +39,7 @@ RESPONSE:
         "enabled": RequireLinearHistory
     },
     "allow_force_pushes": {
-        "enabled": AllowForcePushes
+        "enabled": AllowMainlineForcePushes
     },
     "allow_deletions": {
         "enabled": AllowDeletions
@@ -65,7 +65,9 @@ import requests
 from dbrownell_Common.Types import override  # type: ignore[import-untyped]
 
 from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.AllowDeletions import AllowDeletions
-from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.AllowForcePushes import AllowForcePushes
+from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.AllowMainlineForcePushes import (
+    AllowMainlineForcePushes,
+)
 from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.DismissStalePullRequestApprovals import (
     DismissStalePullRequestApprovals,
 )
@@ -114,7 +116,7 @@ class ClassicBranchProtectionQuery(Query):
             ExecutionStyle.Parallel,
             [
                 AllowDeletions(),
-                AllowForcePushes(),
+                AllowMainlineForcePushes(),
                 DismissStalePullRequestApprovals(),
                 DoNotAllowBypassSettings(),
                 EnsureStatusChecks(),

repoauditor-0.2.43/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/AllowForcePushes.py → repoauditor-0.2.45/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/AllowMainlineForcePushes.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the AllowForcePushes object."""
+"""Contains the AllowMainlineForcePushes object."""
 
 import textwrap
 
@@ -14,13 +14,13 @@ from RepoAuditor.Plugins.GitHub.ClassicBranchProtectionRequirements.Impl.Classic
 
 
 # ----------------------------------------------------------------------
-class AllowForcePushes(ClassicEnableRequirementImpl):
+class AllowMainlineForcePushes(ClassicEnableRequirementImpl):
     """Allow force pushes to the mainline branch."""
 
     # ----------------------------------------------------------------------
     def __init__(self) -> None:
         super().__init__(
-            "AllowForcePushes",
+            "AllowMainlineForcePushes",
             False,
             "true",
             "Rules applied to everyone including administrators",

{repoauditor-0.2.43 → repoauditor-0.2.45}/src/RepoAuditor/__init__.py

@@ -2,4 +2,4 @@ APP_NAME = "RepoAuditor"
 
 # Note that the default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system.
-__version__ = "0.2.43"
+__version__ = "0.2.45"

{repoauditor-0.2.43 → repoauditor-0.2.45}/tests/Plugins/GitHub_EndToEndTest.py

@@ -238,10 +238,10 @@ class TestClassic:
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
 
     # ----------------------------------------------------------------------
-    def test_AllowForcePush(self, pat_args, snapshot):
+    def test_AllowMainlineForcePush(self, pat_args, snapshot):
         result = CliRunner().invoke(
             app,
-            pat_args + ["--GitHub-AllowForcePushes-true"],
+            pat_args + ["--GitHub-AllowMainlineForcePushes-true"],
         )
 
         assert result.exit_code == -1, result.output

{repoauditor-0.2.43 → repoauditor-0.2.45}/tests/Plugins/__snapshots__/GitHub_EndToEndTest.ambr

@@ -43,7 +43,7 @@
   
   '''
 # ---
-# name: TestClassic.test_AllowForcePush
+# name: TestClassic.test_AllowMainlineForcePush
   '''
   Processing 1 module...
     Processing 'GitHub' (1 of 1)...
@@ -64,7 +64,7 @@
   │ Errors:         1 (2.78%)                                                                                                                                                        │
   │ Skipped:        1 (2.78%)                                                                                                                                                        │
   │                                                                                                                                                                                  │
-  │ ╭─ [Error] AllowForcePushes ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
+  │ ╭─ [Error] AllowMainlineForcePushes ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                                                                              │ │
   │ │ Validates that 'Allow force pushes' is set to the expected value.                                                                                                            │ │
   │ │                                                                                                                                                                              │ │