From 4791ca205d3b2738787771369308813182c67c10 Mon Sep 17 00:00:00 2001 From: Wesley Scholl <128409641+wesleyscholl@users.noreply.github.com> Date: Thu, 7 Nov 2024 08:48:54 -0500 Subject: [PATCH] docs: Add CI/CD example for building Argo Workflows. Closes #8591 This commit introduces a detailed example for implementing CI/CD pipelines to build Argo Workflows using Argo Workflows: - **CI**: Includes steps for initializing builds via webhook, building the CLI, using Buildkit for image builds, running tests, collecting coverage reports, deploying to a cluster, and executing basic E2E tests. - **CD**: Covers tagging, updating manifests with kustomize, committing updates, and initiating an Argo CD sync. - **Pipeline**: Integrates CI and CD jobs with an approval step. Signed-off-by: Wesley Scholl Signed-off-by: Wesley Scholl <128409641+wesleyscholl@users.noreply.github.com> --- examples/ci-cd-workflow.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/examples/ci-cd-workflow.yaml b/examples/ci-cd-workflow.yaml index 14b78c92eb5f..7cf90e72665d 100644 --- a/examples/ci-cd-workflow.yaml +++ b/examples/ci-cd-workflow.yaml @@ -1,7 +1,7 @@ # Argo Workflows - CI/CD Setup Guide # # Overview: -# To run this workflow end-to-end, configure the following components. +# To run this CI/CD workflow end-to-end, configure the following components: # # 1. WorkflowEventBinding @@ -26,6 +26,10 @@ # # - Auth Token: Required in the `Authorization` header to trigger WorkflowEventBinding. Follow these steps to create an access token: https://argo-workflows.readthedocs.io/en/latest/access-token/ # +# - The payload is based on a GitHub webhook event. For more information on the payload, see the GitHub webhook documentation: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads +# +# - This workflow focuses on the WorkflowEventBinding setup. To trigger using Argo Events, refer to the Argo Events documentation: https://argoproj.github.io/argo-events/ +# # 2. Docker Configuration #