The GitHub Checks Microservice is a versatile and extensible Go-based application designed to interact with the GitHub API. Its primary purpose is to provide comprehensive checks for GitHub repositories, individual files, and file contents. This microservice is configured through environment variables, offering users flexibility to adapt it to their specific requirements.
-
Repository Exists: This feature enables users to perform a check that the GitHub repository exists.
-
File Exists: Users can check the status of specific files within a repository. This functionality is useful for monitoring the added individual files over time.
-
File Contains: The microservice allows users to inspect the content of files within a GitHub repository. This feature is particularly valuable for analyzing file contents and ensuring compliance with specific content criteria.
The GitHub Checks Microservice is configured through environment variables, providing a straightforward and adaptable setup process. Users can customize the microservice behavior by setting the following environment variables:
CHECK_CALLBACK_URL: URL provided will recieve the check resp.
CHECK_ACTION: The check in which you want to want to preform.
CHECK_ORG: The ORG to check.
CHECK_REPO: The Repository to check.
CHECK_FILE: The File to check
CHECK_STRING: String to check for in file.
Examples:
export CHECK_CALLBACK_URL=localhost:3000
export CHECK_ACTION=repo_exists
export CHECK_ORG=my_org
export CHECK_REPO=my_repo
export CHECK_FILE=my_file
export CHECK_STRING=my_string