github¶
Trigger GitHub workflows via a repository_dispatch.
A repository_dispatch will trigger workflows in the default branch of the GitHub repository. By default, an summary of the performance test will also be sent.
Usage example¶
helm upgrade --install \
--repo https://iter8-tools.github.io/iter8 --version 1.1 httpbin-test iter8 \
--set "tasks={http,github}" \
--set http.url=http://httpbin.default/get \
--set github.owner=<GitHub owner> \
--set github.repo=<GitHub repository> \
--set github.token=<GitHub token>
See here for a more in-depth tutorial.
Parameters¶
| Name | Type | Required | Default value | Description |
|---|---|---|---|---|
| owner | string | Yes | N/A | Owner of the GitHub repository |
| repo | string | Yes | N/A | GitHub repository |
| token | string | Yes | N/A | Authorization token |
| payloadTemplateURL | string | No | https://raw.githubusercontent.com/iter8-tools/iter8/v1.1.1/templates/notify/_payload-github.tpl | URL to a payload template |
| softFailure | bool | No | true | Indicates the performance test should not fail if the task cannot successfully send the request |
Default payload¶
A repository_dispatch requires a payload that contains the type of the event.
The default payload template will set the event_type to iter8. In addition, it will also provide a performance test summary in the client_payload, which means that this data will be accessible in the GitHub workflow via ${{ toJson(github.event.client_payload) }}.
However, if you would like to use a different payload template, simply set a payloadTemplateURL and Iter8 will not use the default.