Skip to content
This repository was archived by the owner on Jul 21, 2025. It is now read-only.
Emil Zackrisson edited this page Feb 19, 2025 · 3 revisions

LICENSE Check

This checks that a LICENSE.* file exists in the repository root or in a directory called LICENSE*. Names are not case-sensitive.

Check Status

✅ : LICENSE file exists and is not empty in either the repository root or in a directory called LICENSE.

⚠ : Multiple LICENSE files found.

❌ : LICENSE file not found or it's empty.

Secrets Check

Checks repository for any secrets using Trufflehog.

The command run is trufflehog git {directory} --json --results=verified,unknown --fail.

Lists all files containing secrets with any found description of the secret.

Check Status

✅ : No secrets was found.

⚠ : Secrets was found but is covered by .gitignore.

❌ : Secrets was found.

.gitignore Check

Checks that a .gitignore file exists in the repository root.

Check Status

✅ : .gitignore file exists in the repository root.

⚠ : .gitignore is empty.

❌ : .gitignore file doesn't exist.

README Check

Checks that a README file exists in the repository root.

Check Status

✅ : README.* file exists in the repository root.

⚠ : README.* is empty.

❌ : README.* file doesn't exist.

GitHub Workflows

Checks that the .github/workflows directory exists and it's not empty.

Check Status

✅ : .github/workflows directory exists

⚠ : .github/workflows directory exists but is empty.

❌ : .github/workflows directory exists doesn't exist.

Test in path Check

Checks if any path in repository contains the string test.

Lists all paths containing test.

Check Status

✅ : Test string exists in a path

❌ : Test string does not exist in a path

Test in file Check

Checks if any file in repository contains the string test.

Lists all files containing "test"

Check Status

✅ : Test string exists in a file

❌ : Test string does not exist in a file

Clone this wiki locally