hologit is a tool that facilitates manipulation of GitHub branches in a manner that facilitates an "obvious" GitOps workflow for CI/CD. Specifically, hologit allows:
- Building branches containing only a subset of repository contents (for example, a branch only including infra-related code)
- This action is called "projection"
- Bringing in contents from another repository without relying on published artifacts such as Helm charts
- Applying transformations to files as part of #1
- These transformations are called "lenses"
In this repository, we declare one holobranch named release-candidate.
By projecting this holobranch in GitHub Actions, individual "candidate" branches end up containing
only the code relevant to infra/Kubernetes as well as Kubernetes code from the upstream cluster-template
repository. Then, a PR from a candidate/<some-branch> to releases/<env> (such as releases/test) will only show changes/content
relevant to infra in addition to releases/* branches only ever containing infra code. For example:
- Create a PR making an infra-related change
- Create and merge a PR to deploy a candidate branch to test
- Merge the PR from #1
- After merge, PR to deploy the main candidate branch to prod