docs: add API changes section to dev guide

fluxcd · Mar 4, 2020 · 9b6ee75 · 9b6ee75
1 parent dad72da
commit 9b6ee75
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/gitbook/dev/dev-guide.md b/docs/gitbook/dev/dev-guide.md
@@ -98,6 +98,22 @@ Run unit tests:
 make test
 ```
 
+### API changes
+
+If you made changes to `pkg/apis` regenerate the Kubernetes client sets with:
+
+```bash
+make codegen
+```
+
+Update the validation spec in `artifacts/flagger/crd.yaml` and run:
+
+```bash
+make crd
+```
+
+Note that any change to the CRDs must be accompanied by an update to the Open API schema.
+
 ### Manual testing
 
 Install a service mesh and/or an ingress controller on your cluster and deploy Flagger