Skip to content

Commit

Permalink
Updates auxiliary function names to be more clear and updates README …
Browse files Browse the repository at this point in the history
…to include new auxiliary check for missing SECURITY.md file
  • Loading branch information
bin3xish477 committed Aug 10, 2023
1 parent 866df1e commit 57347ac
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@ jobs:

#### Auxiliary Checks

1. Name: `check_for_codeowners_file` - checks for existence of [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) file.
1. Name: `check_for_missing_codeowners_file` - checks for missing [CODEOWNERS](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) file.
1. Name: `check_for_missing_security_md_file` - checks for missing [SECURITY.md](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository) file.

### References

Expand Down
4 changes: 2 additions & 2 deletions analyzer/analyzer.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def __init__(
"_check_for_non_github_managed_actions": {"level": "WARN"},
}
self.auxiliary_checks = [
"_check_for_codeowners_file",
"_check_for_missing_codeowners_file",
"_check_for_missing_security_md_file",
]
self.action = {}
Expand Down Expand Up @@ -351,7 +351,7 @@ def _check_for_non_github_managed_actions(self) -> bool:
# ======================== Auxiliary Checks ========================
# ==================================================================

def _check_for_codeowners_file(self) -> None:
def _check_for_missing_codeowners_file(self) -> None:
if not Path(".github/workflows/CODEOWNERS").exists():
print(
f"{Colors.LIGHT_BLUE}AUXI{Colors.END} missing CODEOWNERS file"
Expand Down

0 comments on commit 57347ac

Please sign in to comment.