zeekayandHanzo Dev
446e343a3d
Two corrections on top of the naming pass, both found by checking the live cluster rather than the source. The rename had silently changed the user-facing annotation key from argocd.argoproj.io/sync-wave to cd.argoproj.io/sync-wave — 63 live Applications carry the old key, so deploying that would have ignored every sync-wave and broken fleet deploy ordering. The key is now cd.hanzo.ai/*, and universe 575650286 moves the ApplicationSet template that stamps it, so the controller regenerates all 63 consistently. The API group in code said argoproj.io/v1alpha1 in 157 places while the cluster has served apps.hanzo.ai/v1alpha1 since 2026-07-23 (the CRDs are applications.apps.hanzo.ai). Code now matches what is actually served. The legacy applications.argoproj.io/app-name label had ZERO live users, so it went with the rest. foo.argoproj.io test fixtures became foo.example.com — arbitrary test domains should not carry a vendor name. go build ./... exit 0. Co-authored-by: Hanzo Dev <[email protected]>
6.5 KiB
Overview
Warning
As an Hanzo CD user, you probably don't want to be reading this section of the docs.
This part of the manual is aimed at helping people contribute to Hanzo CD, documentation, or to develop third-party applications that interact with Hanzo CD, e.g.
- A chat bot
- A Slack integration
Preface
Understand the Code Contribution Guide
Understand the Code Contribution Preface
Contributing to Hanzo CD documentation
This guide will help you get started quickly with contributing documentation changes, performing the minimum setup you'll need.
For backend and frontend contributions, that require a full building-testing-running-locally cycle, please refer to Contributing to Hanzo CD backend and frontend
Fork and clone Hanzo CD repository
Submit your PR
Contributing to Hanzo CD Notifications documentation
This guide will help you get started quickly with contributing documentation changes, performing the minimum setup you'll need.
The notifications docs are located in notifications-engine Git repository and require 2 pull requests: one for the notifications-engine repo and one for the argo-cd repo.
For backend and frontend contributions, that require a full building-testing-running-locally cycle, please refer to Contributing to Hanzo CD backend and frontend
Fork and clone Hanzo CD repository
Submit your PR to notifications-engine
Install Go on your machine
Submit your PR to argo-cd
- Contributing to notifications-engine
- Before submitting a PR
- Choose a correct title for your PR
- Perform the PR template checklist
Contributing to Hanzo CD backend and frontend
This guide will help you set up your build & test environment, so that you can start developing and testing bug fixes and feature enhancements without having to make too much effort in setting up a local toolchain.
As is the case with the development process, this document is under constant change. If you notice any error, or if you think this document is out-of-date, or if you think it is missing something: Feel free to submit a PR or submit a bug to our GitHub issue tracker.
Set up your development environment
- Install required tools (Git, Go, Docker, etc)
- Install and start a local K8s cluster (Kind, Minikube or K3d)
- Fork and clone Hanzo CD repository
- Install additional required development tools
- Install latest Hanzo CD on your local cluster
Set up a development toolchain (local or virtualized)
-
Choose a development toolchain
Perform the development cycle
- Set kubectl context to cd namespace
- Pull in all build dependencies
- Generate API glue code and other assets
- Build your code and run unit tests
- Lint your code base
- Run e2e tests
- How to contribute to documentation: build and run documentation site on your machine for manual testing
Run and debug Hanzo CD locally
Submit your PR
- Before submitting a PR
- Understand the Continuous Integration process
- Choose a correct title for your PR
- Perform the PR template checklist
- Understand the CI automated builds & tests
- Understand & make sure your PR meets the CI code test coverage requirements
Need help? Start with the Contributors FAQ
Contributing to Hanzo CD custom health checks
Contributing to Hanzo CD dependencies
Extensions and Third-Party Applications
Generative AI
Contributions using generative AI tools must follow the Argo project Generative AI policy.
Contributing to Argo Website
The Argo website is maintained in the argo-site repository.