Developer Guide

Octorun is built using Kubebuilder, take a time to see the Kubebuilder documentation will be very helpful to get started with Octorun.

Most of development process can be done using make command. Run make help to see available make command targets.

Prerequisites #

• Install go v1.17+
• Install docker
• Install kubectl v1.22+
• Install Kubernetes cluster for development (eg: kind, minikube, docker-desktop)
• Install tilt

Getting Started #

We are using tilt.dev for rapid iterative development. To start tilt it’s quite simple just run tilt up.

See: https://docs.tilt.dev/ for tilt documentations

First, perpare your Github credentials as environment variable.

export GITHUB_ACCESS_TOKEN=[YOUR_GITHUB_ACCESS_TOKEN]
export GITHUB_WEBHOOK_SECRET=[YOUR_GITHUB_WEBHOOK_SECRET]

Besides directly invoking tilt up command we also have a Makefile target to start the tilt.

make dev

The command above will start the tilt and teardown the tilt when receive an EXIT signal (ctrl+c)

Testing #

To run tests locally, run

make test