Add GitHub dispatch provider #369
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Aleksey Pogibelev <aleksey.pogibelev@gmail.com>
Signed-off-by: Aleksey Pogibelev <aleksey.pogibelev@gmail.com>
stefanprodan
reviewed
May 4, 2022
internal/notifier/github_dispatch.go
Outdated
| @@ -0,0 +1,121 @@ | |||
| /* | |||
| Copyright 2020 The Flux authors | |||
There was a problem hiding this comment.
Suggested change
| Copyright 2020 The Flux authors | |
| Copyright 2022 The Flux authors |
docs/spec/v1beta1/provider.md
Outdated
| @@ -730,3 +732,141 @@ kubectl create secret generic webhook-url \ | |||
| --from-literal=address="Endpoint=sb://fluxv2.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=yoursaskeygeneatedbyazure" | |||
| ``` | |||
|
|
|||
| ### 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. | |||
There was a problem hiding this comment.
Suggested change
| 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. |
docs/spec/v1beta1/provider.md
Outdated
|
|
||
| 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` |
There was a problem hiding this comment.
Suggested change
| * 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`. |
docs/spec/v1beta1/provider.md
Outdated
|
|
||
| * 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 `client_payload` contains the event data from the notification controller and looks like this: |
There was a problem hiding this comment.
Suggested change
| * 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.: |
docs/spec/v1beta1/provider.md
Outdated
|
|
||
| #### 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: |
There was a problem hiding this comment.
To trigger a GitHub Actions workflow when a Flux Kustomization finishes reconciling, you need to set the event type on the repository_dispatch to match the Flux object ID:
docs/spec/v1beta1/provider.md
Outdated
| run: echo "running tests.." | ||
| ``` | ||
|
|
||
| ### Setting up the GitHub dispatch provider |
There was a problem hiding this comment.
Let's move this before "Setting up a GitHub workflow" please.
Signed-off-by: Aleksey Pogibelev <aleksey.pogibelev@gmail.com>
Signed-off-by: Aleksey Pogibelev <aleksey.pogibelev@gmail.com>
alekspog
force-pushed
the
feature/add-github-dispatch-provider
branch
from
56e350d
to
e320370
Compare
stefanprodan
added
enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add support for GitHub repository dispatch provider.
Ref: fluxcd/flux2#2122
Fix: #329
Example of the notification message payload in the GitHub workflow