status-im
/
infra-role-github-webhook
mirror of https://github.com/status-im/infra-role-github-webhook.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme 

Signed-off-by: Alexis Pentori <alexis@status.im>
This commit is contained in:
Alexis Pentori 2023-05-30 17:24:03 +02:00
parent 8f12d0989b
commit c44ac9d541
No known key found for this signature in database
GPG Key ID: 65250D2801E47A10
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -4,6 +4,20 @@ This is a helper role that deploy a python server for github webhook
# Configuration
```yaml
The following parameter have to be added
```yaml
github_webhook_service_user:
github_webhook_dest_path:
github_webhook_secret:
github_webhook_ssh_key:
github_webhook_repo_url:
github_webhook_repo_branch:
```
`github_webhook_dest_path` correspond to the base path where the repository will be cloned. The name of the repo owner and the repo name will be added to the path.
The `github_webhook_secret` is generated when configuring the webhook in the repository.
The public key associated to `github_webhook_ssh_key` has to be added as a Deploy key in the repository setting.