From a6e25ed99b4f0512473b220db31bfe654fb618b0 Mon Sep 17 00:00:00 2001 From: Kingdon Barrett Date: Mon, 26 Apr 2021 14:33:05 -0400 Subject: [PATCH] improve the introduction It did not say effectively what you should get out of reading this document in the first paragraph. Signed-off-by: Kingdon Barrett --- docs/use-cases/gh-actions-auto-pr.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/use-cases/gh-actions-auto-pr.md b/docs/use-cases/gh-actions-auto-pr.md index b2050e1c..7188d0f8 100644 --- a/docs/use-cases/gh-actions-auto-pr.md +++ b/docs/use-cases/gh-actions-auto-pr.md @@ -1,8 +1,10 @@ # GitHub Actions Auto PR -In the [Image Update Guide] we saw we can [Push updates to a different branch] by using `.spec.git.push.branch` to push image updates to a different branch than the one used for checkout. +This guide shows how to configure GitHub Actions to open a pull request whenever a selected branch is pushed. -In this example, we configure an `ImageUpdateAutomation` resource to push to a `staging` branch, (which we could set up separately as a preview environment to deploy automatic updates in a staging cluster or namespace.) +In the [Image Update Guide] we saw that Flux's automation can [Push updates to a different branch] by using `.spec.git.push.branch` to push automated image updates to a different branch than the one used for checkout. + +In this example, we configure an `ImageUpdateAutomation` resource to push to a `staging` branch, where we can imagine some policy dictates that updates must be staged and approved before they are deployed in production. ```yaml kind: ImageUpdateAutomation