RepoAuditor 0.2.80__tar.gz → 0.2.81__tar.gz

{repoauditor-0.2.80 → repoauditor-0.2.81}/DEVELOPMENT.md

@@ -77,6 +77,7 @@ Please follow the steps below to complete the configuration.
   - 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 -> Require approvals`.
   - 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`.
   - Under `Protect matching branches`
@@ -101,7 +102,7 @@ Please follow the steps below to complete the configuration.
   - 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)` or an equivalent check.
-  - Enable `Block force pushes`.
+  - Disable `Block force pushes`.
   - Be sure to hit `Save changes` at the end.
 
 ### Development Activities

{repoauditor-0.2.80 → repoauditor-0.2.81}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.80
+Version: 0.2.81
 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
@@ -142,6 +142,41 @@ uvx RepoAuditor --include GitHub \
 
 `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.
 
+### Custom Settings
+
+`RepoAuditor` tries to provide default settings and checks which are considered best practices. However, your team or organization may have different ways of doing things.
+You can override the default settings by specifying the appropriate flag.
+
+We have 3 types of flags:
+
+1. Boolean flags for those settings which are checked to be on by default and you wish to check are off, with the form `Module-no-Requirement` (e.g. `--GitHub-no-MergeCommit`).
+2. Conversely, boolean flags for those settings which are checked to be off by default, and you wish to check are on, denoted by the form `Module-Requirement` (e.g. `--GitHub-AllowDeletions`).
+3. Values flags take a string value to determine what value to enforce, and have the form `Module-Requirement-value` (e.g. `--GitHub-License-value "MIT License"`).
+
+Please run `uvx repoauditor --help` to get the list of all flags available.
+
+#### Examples
+
+For example, `RepoAuditor` by default checks that the setting `Allow rebase merging` is off. If you wish to check that this setting is turned on, you can run:
+
+```shell
+uvx repoauditor --GitHub-RebaseMergeCommit
+```
+
+Similarly, `RepoAuditor` checks if `Issues` are enabled. You can set `RepoAuditor` to check if `Issues` is disabled by specifying
+
+```shell
+uvx repoauditor --GitHub-no-SupportIssues
+```
+
+Finally, `RepoAuditor` by default enforces that the `MIT License` exists for the repository. If your organization requires another license (such as `GPL`), you can enforce that by specifying the license keyword such as:
+
+```shell
+uvx repoauditor --GitHub-License-value "GNU General Public License v2.0"
+```
+
+The types of licenses supported by GitHub can be found [here](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#searching-github-by-license-type). Be sure to specify the full license name, e.g. `GNU General Public License v2.0`.
+
 ### Config File
 
 `RepoAuditor` accepts both a set of flags as well as a configuratin YAML file.
@@ -172,4 +207,4 @@ Additional information can be found at these locations.
 
 ## License
 
-RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
+RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{repoauditor-0.2.80 → repoauditor-0.2.81}/README.md

@@ -115,6 +115,41 @@ uvx RepoAuditor --include GitHub \
 
 `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.
 
+### Custom Settings
+
+`RepoAuditor` tries to provide default settings and checks which are considered best practices. However, your team or organization may have different ways of doing things.
+You can override the default settings by specifying the appropriate flag.
+
+We have 3 types of flags:
+
+1. Boolean flags for those settings which are checked to be on by default and you wish to check are off, with the form `Module-no-Requirement` (e.g. `--GitHub-no-MergeCommit`).
+2. Conversely, boolean flags for those settings which are checked to be off by default, and you wish to check are on, denoted by the form `Module-Requirement` (e.g. `--GitHub-AllowDeletions`).
+3. Values flags take a string value to determine what value to enforce, and have the form `Module-Requirement-value` (e.g. `--GitHub-License-value "MIT License"`).
+
+Please run `uvx repoauditor --help` to get the list of all flags available.
+
+#### Examples
+
+For example, `RepoAuditor` by default checks that the setting `Allow rebase merging` is off. If you wish to check that this setting is turned on, you can run:
+
+```shell
+uvx repoauditor --GitHub-RebaseMergeCommit
+```
+
+Similarly, `RepoAuditor` checks if `Issues` are enabled. You can set `RepoAuditor` to check if `Issues` is disabled by specifying
+
+```shell
+uvx repoauditor --GitHub-no-SupportIssues
+```
+
+Finally, `RepoAuditor` by default enforces that the `MIT License` exists for the repository. If your organization requires another license (such as `GPL`), you can enforce that by specifying the license keyword such as:
+
+```shell
+uvx repoauditor --GitHub-License-value "GNU General Public License v2.0"
+```
+
+The types of licenses supported by GitHub can be found [here](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#searching-github-by-license-type). Be sure to specify the full license name, e.g. `GNU General Public License v2.0`.
+
 ### Config File
 
 `RepoAuditor` accepts both a set of flags as well as a configuratin YAML file.
@@ -145,4 +180,4 @@ Additional information can be found at these locations.
 
 ## License
 
-RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.
+RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

{repoauditor-0.2.80 → repoauditor-0.2.81}/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.80"
+__version__ = "0.2.81"