Give an example of {checkout,push}.branch

As a YAML example, this also shows the YAML/JSON field names. Since field names are different in the Go types, it can be confusing. Signed-off-by: Michael Bridgen <[email protected]>
fluxcd · Mar 15, 2021 · bfd7950 · bfd7950
1 parent 076758a
commit bfd7950
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/spec/v1alpha1/imageupdateautomations.md b/docs/spec/v1alpha1/imageupdateautomations.md
@@ -284,6 +284,19 @@ When `push` is present, the `push.branch` field specifies a branch to push to at
 branch will be created locally if it does not already exist, starting from `.checkout.branch`. If it
 does already exist, updates will be calculated on top of any commits already on the branch.
 
+In the following snippet, updates will be pushed as commits to the branch `auto`, and when that
+branch does not exist at the origin, it will be created locally starting from the branch `main` and
+pushed:
+
+```yaml
+spec:
+  # ... commit, update, etc.
+  checkout:
+    branch: main
+  push:
+    branch: auto
+```
+
 ## Status
 
 The status of an `ImageUpdateAutomation` object records the result of the last automation run.