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
Ansible role for GitHub webhook handler https://docs.github.com/en/webhooks/about-webhooks
19 Commits 2 Branches 0 Tags 89 KiB
Python 92.3%
Jinja 7.7%
Go to file
Jakub Sokołowski f17f63d2ae
server: support specifying commit instead of branch 
In that case repo is just reset to that commit and updates do not happen.

Signed-off-by: Jakub Sokołowski <jakub@status.im>
 		2024-03-11 16:21:11 +01:00
defaults server: support specifying commit instead of branch 2024-03-11 16:21:11 +01:00
files server: support specifying commit instead of branch 2024-03-11 16:21:11 +01:00
meta meta: use full names of Ansible roles 2024-03-11 15:50:42 +01:00
tasks meta: use full names of Ansible roles 2024-03-11 15:50:42 +01:00
templates server: support specifying commit instead of branch 2024-03-11 16:21:11 +01:00
README.md server: support specifying commit instead of branch 2024-03-11 16:21:11 +01:00

README.md

Description

This is a helper role that deploy a python server for github webhook

Configuration

Required configuration:

github_webhook_dest_path: '/opt/repo'
github_webhook_secret: 'super-secret-webhook-secret'
github_webhook_repo_url: 'https://github.com/example-org/example-repo'
github_webhook_repo_version: 'master'

If version is a commit no updates will be performed.

Additionally these options can be useful:

github_webhook_ssh_key: '-----BEGIN OPENSSH PRIVATE KEY-----\n...'
github_webhook_service_user: 'repouser'
github_webhook_user_additional_groups: ['docker']
github_webhook_service_user_uid: 1500

Explanations:

  • github_webhook_dest_path - Absolute path for repository location.
  • github_webhook_secret - Used to configure the webhook in GitHub repository.
  • github_webhook_ssh_key - Optional private SSH key to checkout private repositories.
  • github_webhook_service_user - Define user to own the repo and run the service.
  • github_wehbook_service_user_groups - Modify list of groups of service user.
  • github_webhook_service_user_uid - Change UID of service user to match repo user.