Skip to main content

GitHub Bot

A GitHub Bot takes the guesswork out of PR approvals.

Overview​

As automation is overtaking the world, the meaning of merging a pull request has often changed to deploying. Pressing that button should be done with the necessary confidence. That's why Monokle Bot aims to augment your pull requests with all the tools you need to avoid surprises down the line.

The Monokle Bot aims to be an 'batteries included' solution with little to no configuration needed.

Basics​

Manage Bot​

You can manage the GitHub Bot in Project > Settings. The GitHub Bot will automatically activate whenever you set your first policy. You can deactivate it for the projects or for each repository individually.

Status Checks​

The GitHub Bot adds a status check which is the sum of all misconfigurations for your plain Kubernetes resources and affected Dry Runs. Clicking details will bring you to the audit activity to get a detailed list of all misconfigurations and help you fix them.

By default GitHub does not enforce status checks. You can go to GitHub's Repo > Settings > Branches > main (edit) and check require status checks to pass before merging. Keep in mind that you need to already have had a check run in order to find the monokle/validation option here.

Dry Run Review tools​

The GitHub Bot understands which Helm Charts and Kustomizations were changed in this pull request. A comment will be added to your pull requests which validates each affected dry run and shows you a summary.

The comment contains quicklinks to the Monokle's audit activity to commit a fix for your misconfiguration within seconds. It also contains quicklinks to compare the resulting Dry Run with your target branch so you can avoid surprises when there are small differences between the anticipated and actual resulting configuration.

FAQ​

What is the difference between the Monokle Action and the GitHub Action?​

The Monokle Action is a custom GitHub Action and acts as a wrapper around the CLI which simplifies usage within GitHub Actions workflows. On the other hand, the Monokle Bot is a GitHub App which extends GitHub's functionality to give additional help on pull requests and an out-of-the-box experience.