fix documentation

Author: alekspog

docs/spec/v1beta1/provider.md

@@ -734,13 +734,13 @@ kubectl create secret generic webhook-url \
 
 ### GitHub repository dispatch
 
-The `githubdispatch` webhook triggers a GitHub webhook event called [`repository_dispatch`](https://docs.github.com/en/rest/reference/repos#create-a-repository-dispatch-event) for the selected repository. The `repository_dispatch` event can be used to trigger a GitHub Actions workflow with tests for the deployed service.
+The `githubdispatch` provider generates GitHub events of type [`repository_dispatch`](https://docs.github.com/en/rest/reference/repos#create-a-repository-dispatch-event) for the selected repository. The `repository_dispatch` events can be used to trigger GitHub Actions workflow.
 
 The request includes the `event_type` and `client_payload` fields:
 
-* The `event_type` is generated by GitHub Dispatch provider by combining the Kind, Name and Namespace of the involved object in the format `{Kind}/{Name}.{Namespace}`. For example, the `event_type` for Flux configuration named `podinfo` in the `flux-system` namespace looks like this: `Kustomization/podinfo.flux-system`
+* The `event_type` is generated by GitHub Dispatch provider by combining the Kind, Name and Namespace of the involved object in the format `{Kind}/{Name}.{Namespace}`. For example, the `event_type` for a Flux Kustomization named `podinfo` in the `flux-system` namespace looks like this: `Kustomization/podinfo.flux-system`.
 
-* The `client_payload` contains the event data from the notification controller and looks like this:
+* The `client_payload` contains the Kubernetes event issued by Flux, e.g.:
 
 ```yaml
 {
@@ -765,9 +765,42 @@ The request includes the `event_type` and `client_payload` fields:
 }
 ```
 
+### Setting up the GitHub dispatch provider
+
+```yaml
+apiVersion: notification.toolkit.fluxcd.io/v1beta1
+kind: Provider
+metadata:
+  name: github-dispatch
+  namespace: flux-system
+spec:
+  type: githubdispatch
+  address: https://github.com/stefanprodan/podinfo
+  secretRef:
+    name: api-token
+```
+
+The `address` is the address of your repository where you want to send webhooks to trigger GitHub workflows.
+
+GitHub uses personal access tokens for authentication with its API:
+
+* [GitHub personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)
+
+The provider requires a secret in the same format, with the personal access token as the value for the token key:
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: api-token
+  namespace: default
+data:
+  token: <personal-access-tokens>
+```
+
 #### Setting up a GitHub workflow
 
-You need to add `repository_dispatch` trigger to trigger your GitHub workflow using the Flux notification with the relevant event type:
+To trigger a GitHub Actions workflow when a Flux Kustomization finishes reconciling, you need to set the event type for the repository_dispatch trigger to match the Flux object ID:
 
 ```yaml
 name: test-github-dispatch-provider
@@ -822,7 +855,7 @@ spec:
       name: 'podinfo'
 ```
 
-Now you can the trigger tests in the GitHub workflow for app1 in a staging cluster when the app1 resources defined in `./app1/staging/` are configured by Flux:
+Now you can the trigger tests in the GitHub workflow for app1 in a staging cluster when the app1 resources defined in `./app1/staging/` are reconciled by Flux:
 
 ```yaml
 name: test-github-dispatch-provider
@@ -837,36 +870,3 @@ jobs:
     - name: Run tests
       run: echo "running tests.."
 ```
-
-### Setting up the GitHub dispatch provider
-
-```yaml
-apiVersion: notification.toolkit.fluxcd.io/v1beta1
-kind: Provider
-metadata:
-  name: github-dispatch
-  namespace: flux-system
-spec:
-  type: githubdispatch
-  address: https://github.com/stefanprodan/podinfo
-  secretRef:
-    name: api-token
-```
-
-The `address` is the address of your repository where you want to send webhooks to trigger GitHub workflows.
-
-GitHub uses personal access tokens for authentication with its API:
-
-* [GitHub personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)
-
-The provider requires a secret in the same format, with the personal access token as the value for the token key:
-
-```yaml
-apiVersion: v1
-kind: Secret
-metadata:
-  name: api-token
-  namespace: default
-data:
-  token: <personal-access-tokens>
-```

internal/notifier/github_dispatch.go

@@ -1,5 +1,5 @@
 /*
-Copyright 2020 The Flux authors
+Copyright 2022 The Flux authors
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.