Push to branch #121
Push to branch #121
Conversation
Signed-off-by: Michael Bridgen <michael@weave.works>
This adapts the controller so that it will honour the `.spec.push.branch` field. The behaviour _without_ that field is to check out the branch given in `.spec.checkout.branch`, commit, and push to the origin. With `.spec.push.branch` present, it will try to check out that branch; if it doesn't exist, it'll create it, starting from `.spec.checkout.branch`. Either way it'll commit to that branch and push to the origin. The effect is that all automation will happen on the "push" branch, and (most likely) not be applied into the cluster until merged into whichever branch is synced. When the push branch is deleted, it'll be created anew; otherwise, commits will pile up there as more changes are made. Signed-off-by: Michael Bridgen <michael@weave.works>
There was a problem hiding this comment.
LGTM
Thanks @squaremo will you add this to the API spec docs in a different PR?
I can add it in this one or another -- I paused to see if there were any objections or expressions of urgency. Since you've helpfully approved this PR I'll merge it and write the reference in another :-) |
|
@stefanprodan Do you think we should mark this as experimental in some way? I feel like I need to try building some e.g., GitHub Actions automation on top to make sure it works nicely in the way we anticipate (but don't have time right now) |
|
I'll work on the GH Actions example, if you can update the spec doc to describe the feature it would be great. The whole API is experimental being alpha so I don't think we need to do anything special for this field. |
This implements the simplest workable design for pushing to a branch other than the branch checked out. If
.spec.push.branchis present in theImageUpdateAutomationobject, the controller will check out that branch, creating it if necessary, and commit to it before pushing to the origin repo.This is conceptually and mechanically simple, and does enough to build further automation on -- e.g., a GitHub Action that creates a pull request when it sees the branch created.
Addresses #120.