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 #