RepoAuditor 0.2.67__tar.gz → 0.2.69__tar.gz

repoauditor-0.2.69/DEVELOPMENT.md

@@ -0,0 +1,132 @@
+# DEVELOPMENT GUIDE
+
+## Fork setup
+
+| Step | Command Line | Additional Information |
+| --- | --- | --- |
+| 1. Fork the repository | -- | https://github.com/gt-sse-center/RepoAuditor/fork |
+| 2. Create a PAT for your forked repository | -- | See [PAT setup instructions](README.md#personal-access-token-pat) |
+| 3. Update your forked repository settings to match RepoAuditor's defaults | -- | -- |
+
+## Local Development
+
+### Enlistment
+
+| Step | Command Line | Additional Information |
+| --- | --- | --- |
+| 1. Clone the repository locally. | `git clone https://github.com/gt-sse-center/RepoAuditor` | https://git-scm.com/docs/git-clone |
+| 2. Install [uv](https://github.com/astral-sh/uv). | `curl -LsSf https://astral.sh/uv/install.sh \| sh` on macOS and Linux or <br/>`powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 \| iex"` on Windows | https://docs.astral.sh |
+| 3. Install dependencies. | `uv sync` | https://docs.astral.sh/uv/concepts/projects/sync |
+| 4. Install [pre-commit](https://pre-commit.com/) hooks | `uv run pre-commit install` | https://pre-commit.com/#1-install-pre-commit |
+| 5. If you wish to test against an enterprise server, add a remote named `enterprise` with the corresponding URL | E.g. `git remote add enterprise git@github.gatech.edu:sse-center/RepoAuditor.git` | |
+
+### Setup
+
+#### Basic Setup
+
+Please follow these steps to allow for local testing.
+
+- Fork the `RepoAuditor` repository. We will test against the fork since your generated PAT is applicable only for the fork.
+- Create a PAT file as detailed in the [README](https://github.com/gt-sse-center/RepoAuditor/blob/main/README.md#personal-access-token-pat).
+- Set your forked repository as the `origin` remote (this should already be the case but it's good to verify).
+
+  ```sh
+  git remote add origin git@github.com:<github-username>/RepoAuditor.git
+  ```
+
+- Update the URL in `default_config.yaml` to point to your fork.
+- You should now be able to run the following and see valid output. There will be errors, which we will tackle next.
+
+  ```sh
+  uv run RepoAuditor --config default_config.yaml --GitHub-pat PAT.txt
+  ```
+
+#### Local Testing
+
+You can now run local tests from the project root directory with
+
+```sh
+uv run pytest -k 'not EndToEndTest'
+```
+
+#### End-To-End Testing
+
+To include tests against your `RepoAuditor` fork for comprehensive end-to-end testing, you can run:
+
+```sh
+uv run pytest
+```
+
+In order to run end-to-end tests, which make calls to the GitHub API, you need to configure your forked repository, else you will see a large number of test failures.
+
+Please follow the steps below to complete the configuration.
+
+- On the `General` settings page
+  - Under `Features`
+    - Check `Wikis`.
+    - Check `Issues`.
+    - Check `Projects`.
+  - Under `Pull Requests`
+    - With `Allow merge commits`, set the `Default commit message` to `Pull request title`.
+    - Uncheck `Allow squash merging`.
+    - Uncheck `Allow rebase merging`.
+    - Check `Allow auto-merge`.
+    - Check `Automatically delete head branches`.
+
+- On the `Branches` settings page
+  - Click `Add classic branch protection rule`.
+  - Under `Branch name pattern`, type in `main`.
+  - Check `Require a pull request before merging`.
+  - Check `Require a pull request before merging -> Dismiss stale pull request approvals when new commits are pushed`.
+  - Check `Require a pull request before merging -> Require approval of the most recent reviewable push`.
+  - Check `Require status checks to pass before merging`, and add the `CI+CD Workflow / Validate (ubuntu-latest, 3.13)` or equivalent status check.
+  - Check `Require conversation resolution before merging`.
+  - Check `Require signed commits`.
+  - Check `Do not allow bypassing the above settings`.
+
+- On the `Advanced Security` settings page
+  - Enable `Dependabot security updates`.
+
+- Go to the `Actions` tab
+  - Enable Workflows by clicking on `I understand my workflows, go ahead and enable them`.
+  - Run the `CI+CD` workflow. You will be asked to enable it, please do so.
+  - In the `Run workflow` dropdown to the right, click the `Run workflow` button. This should cause the action to run, don't worry if it fails, it is only needed for a check below.
+
+- On the `Rules -> Rulesets` settings page, create a new branch ruleset called `Protect Main`:
+  - Under `Target branches`, click `Add target -> Include by pattern` and type in `main`. Finalize by clicking `Add Inclusion pattern`.
+  - Enable `Restrict deletions`
+  - Enable `Require signed commits`
+  - Enable `Require a pull request before merging` with 1 required approval.
+  - Enable `Require status checks to pass` with the `CI+CD Workflow / Validate (ubuntu-latest, 3.12)` check.
+  - Disable `Block force pushes`.
+  - Be sure to hit `Save changes` at the end.
+
+### Development Activities
+
+| Activity | Command Line | Description | Used During Local Development | Invoked by Continuous Integration |
+| --- | --- | --- | :-: | :-: |
+| Code Formatting | `uv run ruff format` or<br>`uv run ruff format --check` | Format source code using [ruff](https://github.com/astral-sh/ruff) based on settings in `pyproject.toml`. | :white_check_mark: | :white_check_mark: (via [pre-commit](https://pre-commit.com/)) |
+| Sort Imports | `uv run ruff check --fix --select I` | Sort imports in source files. | :white_check_mark: | |
+| Static Code Analysis | `uv run ruff check` | Validate source code using [ruff](https://github.com/astral-sh/ruff) based on settings in `pyproject.toml`. | :white_check_mark: | :white_check_mark: (via [pre-commit](https://pre-commit.com/)) |
+| Run pre-commit scripts | `uv run pre-commit run` | Run [pre-commit](https://pre-commit.com/) scripts based on settings in `.pre-commit-config.yaml`. | :white_check_mark: | :white_check_mark: |
+| Automated Testing | `uv run pytest` or<br/>`uv run pytest --no-cov` | Run automated tests using [pytest](https://docs.pytest.org/) and extract code coverage using [coverage](https://coverage.readthedocs.io/) based on settings in `pyproject.toml`. | :white_check_mark: | :white_check_mark: |
+| Semantic Version Generation | `uv run python -m AutoGitSemVer.scripts.UpdatePythonVersion ./src/RepoAuditor/__init__.py ./src` | Generate a new [Semantic Version](https://semver.org/) based on git commits using [AutoGitSemVer](https://github.com/davidbrownell/AutoGitSemVer). Version information is stored in `./src/RepoAuditor/__init__.py`. | | :white_check_mark: |
+| Python Package Creation | `uv build` | Create a python package using [uv](https://github.com/astral-sh/uv) based on settings in `pyproject.toml`. Generated packages will be written to `./dist`. | | :white_check_mark: |
+| Sign Artifacts | `uv run --with py-minisign python -c "import minisign; minisign.SecretKey.from_file(<temp_filename>).sign_file(<filename>, trusted_comment='<package_name> v<package_version>', drop_signature=True)` | Signs artifacts using [py-minisign](https://github.com/x13a/py-minisign). Note that the private key is stored as a [GitHub secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions). | | :white_check_mark: |
+| Python Package Publishing | `uv publish` | Publish a python package to [PyPi](https://pypi.org/) using [uv](https://github.com/astral-sh/uv) based on settings in `pyproject.toml`. | | :white_check_mark: |
+
+### Contributing Changes
+
+Pull requests are preferred, since they are specific. For more about how to create a pull request, see [this guide](https://help.github.com/articles/using-pull-requests/).
+
+We recommend creating different branches for different (logical) changes, and creating a pull request into the `main` branch when you're done. For more information on creating branches, please see [this GitHub guide](https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/).
+
+### Verifying Signed Artifacts
+
+Artifacts are signed and validated using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
+
+To verify that an artifact is valid, visit [the latest release](https://github.com/gt-sse-center/RepoAuditor/releases/latest) and download the `.minisign` signature file that corresponds to the artifact, then run the following command, replacing `<filename>` with the name of the artifact to be verified:
+
+```shell
+uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>')"
+```

{repoauditor-0.2.67 → repoauditor-0.2.69}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.67
+Version: 0.2.69
 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
@@ -25,6 +25,8 @@ Requires-Dist: typer-config[yaml]>=1.4.2
 Requires-Dist: typer>=0.15.3
 Description-Content-Type: text/markdown
 
+# RepoAuditor - README
+
 **Project:**
 [![License](https://img.shields.io/github/license/gt-sse-center/RepoAuditor?color=dark-green)](https://github.com/gt-sse-center/RepoAuditor/blob/master/LICENSE)
 
@@ -42,21 +44,28 @@ Description-Content-Type: text/markdown
 <!-- Content above this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
 
 ## Contents
+
 - [Installation](#installation)
 - [Overview](#overview)
   - [How to use RepoAuditor](#how-to-use-repoauditor)
-  - [Personal Access Token](#personal-access-token)
+  - [Personal Access Token](#personal-access-token-pat)
   - [Example Usage](#example-usage)
+  - [Config File](#config-file)
 - [Development](#development)
-  - [Verifying Signed Artifacts](#verifying-signed-artifacts)
 - [Additional Information](#additional-information)
 - [License](#license)
 
 ## Installation
 
-You can install `RepoAuditor` via `uv` or `pip`.
+We recommend using [uv](https://docs.astral.sh/uv/#uv) since it can install `RepoAuditor` as a tool via `uvx` into a sandbox environment for quick use.
+This lets you directly run `RepoAuditor`.
+
+```sh
+uvx RepoAuditor
+```
 
-We recommend using [uv](https://docs.astral.sh/uv/#uv) since `RepoAuditor` uses `uv` to create and manage a virtual environment.
+Alternatively, yuou can install `RepoAuditor` via `uv` or `pip`.
+`uv` is preferred to `pip` since it creates and manages a virtual environment.
 
 | Installation Method | Command |
 | --- | --- |
@@ -70,28 +79,27 @@ We recommend using [uv](https://docs.astral.sh/uv/#uv) since `RepoAuditor` uses
 <!-- Content below this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
 
 Once installed, you can invoke the following to verify if `RepoAuditor` is installed correctly:
+
 ```shell
-uv run repo_auditor --version
+uvx RepoAuditor --version
 ```
+
 and you should see something like
+
 ```shell
 RepoAuditor vX.X.X
 ```
 
 To get a list of command line options, you can run
-```shell
-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
+uvx RepoAuditor --help
 ```
 
 ### Personal Access Token (PAT)
 
 The most common use case for `RepoAuditor` would be to audit a GitHub repository.
-In order to allow `RepoAuditor` to read the repository, you first need to generate a Personal Access Token or PAT.
+In order to allow `RepoAuditor` to read the repository, you first need to generate a Personal Access Token or **PAT**.
 
 Please refer to the [GitHub documentation on Personal Access Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) for details about a `Fine-grained PAT` which we will be using.
 
@@ -103,39 +111,53 @@ To generate the Fine-grained PAT, we perform the following steps:
 4. Set an appropriate expiration date.
 5. Under `Repository Access`, select `All repositories`.
 6. For permissions, we need to go to `Repository permissions`.
-7. Enable Read-Write access to `Contents`, and Read access to `Administration`, `Secret Scanning` and `Dependabot Alerts`.
+7. Enable the following permissions:
+    - Read-Write access to `Contents`.
+    - Read access to `Administration` and `Secret scanning alerts`.
 8. Click on `Generate token`.
 9. Copy the generated string. This is your PAT.
+10. Save the PAT to a convenient location on your machine (such as your hime directory `~/`) in the file `PAT.txt`.
 
-After obtaining the PAT, you can save it in a file (e.g. `PAT`) which `RepoAuditor` can read on operation.
+The path to the `PAT.txt` will be passed into `RepoAuditor`. E.g.
+
+```shell
+uvx RepoAuditor --GitHub-pat ~/PAT.txt
+```
 
 ### Example Usage
 
 With the above generated PAT file, you can now run `RepoAuditor` on your GitHub repository.
-As an example, we will use the [python-helloworld](https://github.com/dbarnett/python-helloworld) repo.
 
-**NOTE** You need to fork the repository since your default PAT only has access to repos under your account.
+As a general example, we will use the [python-helloworld](https://github.com/dbarnett/python-helloworld) repository.
+
+> **NOTE** You need to fork the repository since your default PAT only has access to repos under your account.
 
 To run `RepoAuditor`, we can enter the following in the command-line:
+
 ```shell
-uv run repo_auditor --include GitHub --GitHub-url https://github.com/<username>/python-helloworld --GitHub-pat PAT
+uvx RepoAuditor --include GitHub \
+  --GitHub-url https://github.com/<username>/python-helloworld \
+  --GitHub-pat ~/PAT.txt
 ```
 
 `RepoAuditor` will generate a series of messages describing all the issues in the repository, along with the rationale behind them and the steps for resolution.
 
-## Development
-Please visit [Contributing](https://github.com/gt-sse-center/RepoAuditor/blob/main/CONTRIBUTING.md) and [Development](https://github.com/gt-sse-center/RepoAuditor/blob/main/DEVELOPMENT.md) for information on contributing to this project.
-
-### Verifying Signed Artifacts
-Artifacts are signed and validated using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
+### Config File
 
-To verify that an artifact is valid, visit [the latest release](https://github.com/gt-sse-center/RepoAuditor/releases/latest) and download the `.minisign` signature file that corresponds to the artifact, then run the following command, replacing `<filename>` with the name of the artifact to be verified:
+`RepoAuditor` accepts both a set of flags as well as a configuratin YAML file.
 
+The configuration (or config) file can make usage easier by recording preferences as well as facilitating sharing of enforced requirements within an organization.
+We have provided a sample configuration file called [default_config.yaml](https://github.com/gt-sse-center/RepoAuditor/blob/main/default_config.yaml), which can be used as:
 ```shell
-uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>')"
+uvx run RepoAuditor --config default_config.yaml
 ```
 
+## Development
+
+Please visit [Contributing](https://github.com/gt-sse-center/RepoAuditor/blob/main/CONTRIBUTING.md) and [Development](https://github.com/gt-sse-center/RepoAuditor/blob/main/DEVELOPMENT.md) for information on contributing to this project.
+
 ## Additional Information
+
 Additional information can be found at these locations.
 
 | Title | Document | Description |
@@ -148,4 +170,5 @@ Additional information can be found at these locations.
 | Security | [SECURITY.md](https://github.com/gt-sse-center/RepoAuditor/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. |
 
 ## License
+
 RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{repoauditor-0.2.67 → repoauditor-0.2.69}/README.md

@@ -1,3 +1,5 @@
+# RepoAuditor - README
+
 **Project:**
 [![License](https://img.shields.io/github/license/gt-sse-center/RepoAuditor?color=dark-green)](https://github.com/gt-sse-center/RepoAuditor/blob/master/LICENSE)
 
@@ -15,21 +17,28 @@
 <!-- Content above this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
 
 ## Contents
+
 - [Installation](#installation)
 - [Overview](#overview)
   - [How to use RepoAuditor](#how-to-use-repoauditor)
-  - [Personal Access Token](#personal-access-token)
+  - [Personal Access Token](#personal-access-token-pat)
   - [Example Usage](#example-usage)
+  - [Config File](#config-file)
 - [Development](#development)
-  - [Verifying Signed Artifacts](#verifying-signed-artifacts)
 - [Additional Information](#additional-information)
 - [License](#license)
 
 ## Installation
 
-You can install `RepoAuditor` via `uv` or `pip`.
+We recommend using [uv](https://docs.astral.sh/uv/#uv) since it can install `RepoAuditor` as a tool via `uvx` into a sandbox environment for quick use.
+This lets you directly run `RepoAuditor`.
+
+```sh
+uvx RepoAuditor
+```
 
-We recommend using [uv](https://docs.astral.sh/uv/#uv) since `RepoAuditor` uses `uv` to create and manage a virtual environment.
+Alternatively, yuou can install `RepoAuditor` via `uv` or `pip`.
+`uv` is preferred to `pip` since it creates and manages a virtual environment.
 
 | Installation Method | Command |
 | --- | --- |
@@ -43,28 +52,27 @@ We recommend using [uv](https://docs.astral.sh/uv/#uv) since `RepoAuditor` uses
 <!-- Content below this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
 
 Once installed, you can invoke the following to verify if `RepoAuditor` is installed correctly:
+
 ```shell
-uv run repo_auditor --version
+uvx RepoAuditor --version
 ```
+
 and you should see something like
+
 ```shell
 RepoAuditor vX.X.X
 ```
 
 To get a list of command line options, you can run
-```shell
-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
+uvx RepoAuditor --help
 ```
 
 ### Personal Access Token (PAT)
 
 The most common use case for `RepoAuditor` would be to audit a GitHub repository.
-In order to allow `RepoAuditor` to read the repository, you first need to generate a Personal Access Token or PAT.
+In order to allow `RepoAuditor` to read the repository, you first need to generate a Personal Access Token or **PAT**.
 
 Please refer to the [GitHub documentation on Personal Access Tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) for details about a `Fine-grained PAT` which we will be using.
 
@@ -76,39 +84,53 @@ To generate the Fine-grained PAT, we perform the following steps:
 4. Set an appropriate expiration date.
 5. Under `Repository Access`, select `All repositories`.
 6. For permissions, we need to go to `Repository permissions`.
-7. Enable Read-Write access to `Contents`, and Read access to `Administration`, `Secret Scanning` and `Dependabot Alerts`.
+7. Enable the following permissions:
+    - Read-Write access to `Contents`.
+    - Read access to `Administration` and `Secret scanning alerts`.
 8. Click on `Generate token`.
 9. Copy the generated string. This is your PAT.
+10. Save the PAT to a convenient location on your machine (such as your hime directory `~/`) in the file `PAT.txt`.
 
-After obtaining the PAT, you can save it in a file (e.g. `PAT`) which `RepoAuditor` can read on operation.
+The path to the `PAT.txt` will be passed into `RepoAuditor`. E.g.
+
+```shell
+uvx RepoAuditor --GitHub-pat ~/PAT.txt
+```
 
 ### Example Usage
 
 With the above generated PAT file, you can now run `RepoAuditor` on your GitHub repository.
-As an example, we will use the [python-helloworld](https://github.com/dbarnett/python-helloworld) repo.
 
-**NOTE** You need to fork the repository since your default PAT only has access to repos under your account.
+As a general example, we will use the [python-helloworld](https://github.com/dbarnett/python-helloworld) repository.
+
+> **NOTE** You need to fork the repository since your default PAT only has access to repos under your account.
 
 To run `RepoAuditor`, we can enter the following in the command-line:
+
 ```shell
-uv run repo_auditor --include GitHub --GitHub-url https://github.com/<username>/python-helloworld --GitHub-pat PAT
+uvx RepoAuditor --include GitHub \
+  --GitHub-url https://github.com/<username>/python-helloworld \
+  --GitHub-pat ~/PAT.txt
 ```
 
 `RepoAuditor` will generate a series of messages describing all the issues in the repository, along with the rationale behind them and the steps for resolution.
 
-## Development
-Please visit [Contributing](https://github.com/gt-sse-center/RepoAuditor/blob/main/CONTRIBUTING.md) and [Development](https://github.com/gt-sse-center/RepoAuditor/blob/main/DEVELOPMENT.md) for information on contributing to this project.
-
-### Verifying Signed Artifacts
-Artifacts are signed and validated using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
+### Config File
 
-To verify that an artifact is valid, visit [the latest release](https://github.com/gt-sse-center/RepoAuditor/releases/latest) and download the `.minisign` signature file that corresponds to the artifact, then run the following command, replacing `<filename>` with the name of the artifact to be verified:
+`RepoAuditor` accepts both a set of flags as well as a configuratin YAML file.
 
+The configuration (or config) file can make usage easier by recording preferences as well as facilitating sharing of enforced requirements within an organization.
+We have provided a sample configuration file called [default_config.yaml](https://github.com/gt-sse-center/RepoAuditor/blob/main/default_config.yaml), which can be used as:
 ```shell
-uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>')"
+uvx run RepoAuditor --config default_config.yaml
 ```
 
+## Development
+
+Please visit [Contributing](https://github.com/gt-sse-center/RepoAuditor/blob/main/CONTRIBUTING.md) and [Development](https://github.com/gt-sse-center/RepoAuditor/blob/main/DEVELOPMENT.md) for information on contributing to this project.
+
 ## Additional Information
+
 Additional information can be found at these locations.
 
 | Title | Document | Description |
@@ -121,4 +143,5 @@ Additional information can be found at these locations.
 | Security | [SECURITY.md](https://github.com/gt-sse-center/RepoAuditor/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. |
 
 ## License
+
 RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/AllowDeletions.py

@@ -22,7 +22,7 @@ class AllowDeletions(ClassicEnableRequirementImpl):
         super().__init__(
             "AllowDeletions",
             False,
-            "true",
+            "enabled",
             "Rules applied to everyone including administrators",
             "Allow deletions",
             lambda data: data["branch_protection_data"]["allow_deletions"]["enabled"],

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/AllowMainlineForcePushes.py

@@ -22,7 +22,7 @@ class AllowMainlineForcePushes(ClassicEnableRequirementImpl):
         super().__init__(
             "AllowMainlineForcePushes",
             False,
-            "true",
+            "enabled",
             "Rules applied to everyone including administrators",
             "Allow force pushes",
             lambda data: data["branch_protection_data"]["allow_force_pushes"]["enabled"],

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/DismissStalePullRequestApprovals.py

@@ -23,7 +23,7 @@ class DismissStalePullRequestApprovals(ClassicEnableRequirementImpl):
         super().__init__(
             "DismissStalePullRequestApprovals",
             True,
-            "false",
+            "disabled",
             "Protect matching branches",
             "Require a pull request before merging -> Dismiss stale pull request approvals when new commits are pushed",
             _GetValue,

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/DoNotAllowBypassSettings.py

@@ -22,7 +22,7 @@ class DoNotAllowBypassSettings(ClassicEnableRequirementImpl):
         super().__init__(
             "DoNotAllowBypassSettings",
             True,
-            "false",
+            "disabled",
             "Protect matching branches",
             "Do not allow bypassing the above settings",
             lambda data: data["branch_protection_data"]["enforce_admins"]["enabled"],

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/EnsureStatusChecks.py

@@ -57,7 +57,7 @@ class EnsureStatusChecks(Requirement):
     def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
         """Get the definitions for the arguments to this requirement."""
         return {
-            "disable": (
+            "disabled": (
                 bool,
                 typer.Option(
                     default=False,
@@ -73,7 +73,7 @@ class EnsureStatusChecks(Requirement):
         query_data: dict[str, Any],
         requirement_args: dict[str, Any],
     ) -> Requirement.EvaluateImplResult:
-        if requirement_args["disable"]:
+        if requirement_args["disabled"]:
             return Requirement.EvaluateImplResult(
                 EvaluateResult.DoesNotApply,
                 "The status check requirement has been explicitly disabled.",

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireApprovalMostRecentPush.py

@@ -23,7 +23,7 @@ class RequireApprovalMostRecentPush(ClassicEnableRequirementImpl):
         super().__init__(
             "RequireApprovalMostRecentPush",
             True,
-            "false",
+            "disabled",
             "Protect matching branches",
             "Require a pull request before merging -> Require approval of the most recent reviewable push",
             _GetValue,

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireCodeOwnerReview.py

@@ -23,7 +23,7 @@ class RequireCodeOwnerReview(ClassicEnableRequirementImpl):
         super().__init__(
             "RequireCodeOwnerReview",
             False,
-            "true",
+            "enabled",
             "Protect matching branches",
             "Require a pull request before merging -> Require review from Code Owners",
             _GetValue,

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireConversationResolution.py

@@ -22,7 +22,7 @@ class RequireConversationResolution(ClassicEnableRequirementImpl):
         super().__init__(
             "RequireConversationResolution",
             True,
-            "false",
+            "disabled",
             "Protect matching branches",
             "Require conversation resolution before merging",
             lambda data: data["branch_protection_data"]["required_conversation_resolution"]["enabled"],

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireLinearHistory.py

@@ -22,7 +22,7 @@ class RequireLinearHistory(ClassicEnableRequirementImpl):
         super().__init__(
             "RequireLinearHistory",
             False,
-            "true",
+            "enabled",
             "Protect matching branches",
             "Require linear history",
             lambda data: data["branch_protection_data"]["required_linear_history"]["enabled"],

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequirePullRequests.py

@@ -22,7 +22,7 @@ class RequirePullRequests(ClassicEnableRequirementImpl):
         super().__init__(
             "RequirePullRequests",
             True,
-            "false",
+            "disabled",
             "Protect matching branches",
             "Require a pull request before merging",
             lambda data: "required_pull_request_reviews" in data["branch_protection_data"],

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireSignedCommits.py

@@ -22,7 +22,7 @@ class RequireSignedCommits(ClassicEnableRequirementImpl):
         super().__init__(
             "RequireSignedCommits",
             True,
-            "false",
+            "disabled",
             "Protect matching branches",
             "Require signed commits",
             lambda data: data["branch_protection_data"]["required_signatures"]["enabled"],

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireStatusChecksToPass.py

@@ -22,7 +22,7 @@ class RequireStatusChecksToPass(ClassicEnableRequirementImpl):
         super().__init__(
             "RequireStatusChecksToPass",
             True,
-            "false",
+            "disabled",
             "Protect matching branches",
             "Require status checks to pass before merging",
             lambda data: "required_status_checks" in data["branch_protection_data"],

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/ClassicBranchProtectionRequirements/RequireUpToDateBranches.py

@@ -23,7 +23,7 @@ class RequireUpToDateBranches(ClassicEnableRequirementImpl):
         super().__init__(
             "RequireUpToDateBranches",
             True,
-            "false",
+            "disabled",
             "Protect matching branches",
             "Require status checks to pass before merging -> Require branches to be up to date before merging",
             _GetValue,

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/DefaultBranchRequirements/Protected.py

@@ -56,7 +56,7 @@ class Protected(Requirement):
     def GetDynamicArgDefinitions(self) -> dict[str, TypeDefinitionItemType]:
         """Get the definitions for the arguments to this requirement."""
         return {
-            "false": (
+            "disabled": (
                 bool,
                 typer.Option(
                     default=False,
@@ -78,7 +78,7 @@ class Protected(Requirement):
         if is_protected is None:
             return CreateIncompleteDataResult()
 
-        if requirement_args["false"]:
+        if requirement_args["disabled"]:
             expected_value = False
             provide_rationale = False
         else:

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/StandardRequirements/AutoMerge.py

@@ -22,7 +22,7 @@ class AutoMerge(StandardEnableRequirementImpl):
         super().__init__(
             "AutoMerge",
             True,
-            "false",
+            "disabled",
             "settings",
             "Pull Requests",
             "Allow auto-merge",

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/StandardRequirements/DeleteHeadBranches.py

@@ -22,7 +22,7 @@ class DeleteHeadBranches(StandardEnableRequirementImpl):
         super().__init__(
             "DeleteHeadBranches",
             True,
-            "false",
+            "disabled",
             "settings",
             "Pull Requests",
             "Automatically delete head branches",

{repoauditor-0.2.67 → repoauditor-0.2.69}/src/RepoAuditor/Plugins/GitHub/StandardRequirements/MergeCommit.py

@@ -22,7 +22,7 @@ class MergeCommit(StandardEnableRequirementImpl):
         super().__init__(
             "MergeCommit",
             True,
-            "false",
+            "disabled",
             "settings",
             "Pull Requests",
             "Allow merge commits",