From 85b3eeb87bad1f36b96a337e1ae018138c42c455 Mon Sep 17 00:00:00 2001 From: Kingdon Barrett Date: Mon, 26 Apr 2021 12:42:33 -0400 Subject: [PATCH] proofreading changes The menu entry in the Use Cases section was missing, and some of the text needed additional words to be added in order to make better sense. Signed-off-by: Kingdon Barrett --- docs/use-cases/gh-actions-auto-pr.md | 8 +++++--- mkdocs.yml | 1 + 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/use-cases/gh-actions-auto-pr.md b/docs/use-cases/gh-actions-auto-pr.md index 0a4aab76..b2050e1c 100644 --- a/docs/use-cases/gh-actions-auto-pr.md +++ b/docs/use-cases/gh-actions-auto-pr.md @@ -2,7 +2,7 @@ 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. -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 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.) ```yaml kind: ImageUpdateAutomation @@ -17,6 +17,8 @@ spec: branch: staging ``` +For this use case, we are only interested in showing that once the change is approved and merged, it gets deployed into production. The image automation is gated behind a pull request approval workflow, according to any policy you have in place for your repository. + In your manifest repository, add a GitHub Action workflow as below. This workflow watches for commits on the `staging` branch and opens a pull request with any labels, title, or body that you configure. ```yaml @@ -45,9 +47,9 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} ``` -You can use the [github-pull-request-action] workflow to automatically open a pull request against a destination branch. In this case, when a pull request is merged into the main changes are deployed in production. +You can use the [github-pull-request-action] workflow to automatically open a pull request against a destination branch. In this case, when `staging` is merged into the `main` branch, changes are deployed in production. -This way you can manually approve automatic image updates before they are applied on your production clusters. +This way you can automatically push changes to a `staging` branch and require manual approval of any automatic image updates before they are applied on your production clusters. [Image Update Guide]: /guides/image-update/ [Push updates to a different branch]: /guides/image-update/#push-updates-to-a-different-branch diff --git a/mkdocs.yml b/mkdocs.yml index 0e4e5248..76a6658a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,6 +67,7 @@ nav: - Use Cases: - Azure: use-cases/azure.md - GitHub Actions Manifest Generation: use-cases/gh-actions-manifest-generation.md + - GitHub Actions Auto Pull Request: use-cases/gh-actions-auto-pr.md - Helm: use-cases/helm.md - Toolkit Components: - Overview: components/index.md