Golang Repository Template

This repository serves as a starting point for new Golang projects. It includes a Makefile with common development targets with make, a pre-configured development environment using Devbox, GitHub Actions workflows, and release-please-action for release automation.

The template is configured with Kubebuilder v4 for building Kubernetes operators. Kubebuilder manifests in config/ are automatically synced to the Helm chart using the kubebuilder.sync-chart make target, which uses the Kubebuilder Helm plugin to keep your chart in sync with generated RBAC, manager, and other Kubernetes resources

Prerequisites

...

Usage Instructions

Use this repo as the template for a new repository by making the following changes.

Changes in the repository

1. Add an initial version for release-please.

   git commit --allow-empty -m "chore: release 0.0.1" -m "Release-As: 0.0.1" && git push origin main

2. Search and replace all instances of golang-repository-template and Golang Repository Template with your project's name.

3. Search and replace all instances of github.com/dkoshkin with your Github username.

4. Search and replace all instances of com.dimitrikoshkin with your company domain.

5. Rename the folder in cmd/ and charts/ with your project's name.

6. Update the files in hack/license with your details.

7. Clear out the release-please version.

   echo "{}" > .release-please-manifest.json

Kubebuilder

This template is initialized with Kubebuilder to build Kubernetes controllers. To remove, make the following changes:

1. Remove kubebuilder.sync-chart target in make/goreleaser.mk.
2. Remove generate manifests target from make/go.mk.
3. Delete the make/kubebuilder.mk and remove its reference from make/all.mk.
4. Delete the PROJECT file.
5. Delete the config/ directory.

Changes in Github

1. Go to Settings > General and enable Allow auto-merge and Automatically delete head branches.
2. Go to Settings > General > Pull Requests and unselect Allow merge commits and Allow rebase merging.
3. Create a Github PATs to use in Github automation.

   • Another to use with Devbox update automation, adding the following permissions:

     • Contents: read and write
     • Pull Requests: read and write
     • Issues: read and write

     Go to Settings > Secrets and variables > Actions and add is as DEPENDENCY_AUTOMATION_TOKEN.

     Go to Settings > Secrets and variables > Actions and add these Secrets GIT_SSH_SIGNING_PRIVATE_KEY, GIT_USER_NAME and GIT_USER_EMAIL.

4. Go to Settings > Branches > Add branch ruleset and configure it for the "default" and release/**/* branches. Enable Require signed commits and Require a pull request before merging. Enable Require status checks to pass with the following checks:
   • build / build
   • lint / gha
   • lint / go (.)
   • lint / helm
   • pre-commit / pre-commit
   • unit-tests / unit-tests
   • govulncheck / govulncheck (.)
   • codeql / analyze (go)
   • e2e-tests / e2e-tests
5. Go to Settings > Pages > Branch and select main and /docs as the Source.

Changes in Codecov

This template is configured with Codecov that must be configured before using.

Go to Settings > Secrets and variables > Actions and add the generated token as CODECOV_TOKEN.

Setup your Dev Environment

1. Install Devbox
2. Install direnv
   • run direnv allow
3. Install pre-commit git hooks
   • run pre-commit install

Tip: to see all available make targets with descriptions, simply run make.

Test

make test

This repository is configured with Codecov but can be removed by modifying .github/workflows/unit-tests.yml.

Build

make build-snapshot

The binary for your OS will be placed in ./dist, e.g. ./dist/golang-repository-template_darwin_arm64_v8.0/golang-repository-template:

Lint

make lint
make lint-chart

Pre-commit

make pre-commit

Helm Chart

make chart-docs
make schema-chart

Build Tooling

The repository is configured with automation to periodically update dependencies.

• dependabot action to update both Github Actions and Golang go.mod dependencies using Dependabot.
• devbox action to update Devbox packages.