nathandeamer/github-release-checker repository overview

⁠Github Release Checker

Send a notification to slack counting the number of commits the github configured default branch (main/master) is behind the tag prod. If tag is not found, repo will be ignored

⁠Example

⁠Prerequisites

• On release to production, the git-sha should be tagged with the GITHUB_TAG value (default: prod) by your CI/CD pipeline

• Slack webhook configured
  Configure the incoming webhooks⁠ slack integration

• Github Github Personal Access Token⁠ created
  Note: Github Release Checker
  Expiration: No Expiration
  Scopes: repo:status

⁠Usage

The application will exit after it has finished running. It has been designed to be ran as a cron job.

1. Set environment variables:
   GITHUB_USER OR GITHUB_ORGANISATION
GITHUB_TOKEN
GITHUB_TAG default prod
SLACK_WEBHOOKURL
THRESHOLD_CRITICAL default 3
EXCLUDED - list of repo names to ignore

⁠Installation (k8s)

TODO: Build a helm chart (cronjob)

⁠Local usage:

1. Build the image: ./gradlew bootBuildImage --imageName=nathandeamer/github-release-checker
2. Run with docker:

docker run \
  --env GITHUB_ORGANISATION/GITHUB_USER=x \
  --env GITHUB_TOKEN=x \
  --env SLACK_WEBHOOKURL=x \
  --rm nathandeamer/github-release-checker