github_hooks - Manages GitHub service hooks.
New in version 1.4.
Synopsis
- Adds service hooks and removes service hooks that have an error status.
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| action |
yes |
|
This tells the githooks module what you want it to do.
|
|
| content_type |
no | json |
|
Content type to use for requests made to the webhook
|
| hookurl |
no |
When creating a new hook, this is the url that you want GitHub to post to. It is only required when creating a new hook.
|
||
| oauthkey |
yes |
The oauth key provided by GitHub. It can be found/generated on GitHub under "Edit Your Profile" >> "Developer settings" >> "Personal Access Tokens"
|
||
| repo |
yes |
This is the API url for the repository you want to manage hooks for. It should be in the form of: https://api.github.com/repos/user:/repo:. Note this is different than the normal repo url.
|
||
| user |
yes |
Github username.
|
||
| validate_certs |
no | yes |
|
If no, SSL certificates for the target repo will not be validated. This should only be used on personally controlled sites using self-signed certificates.
|
Examples
# Example creating a new service hook. It ignores duplicates.
- github_hooks:
action: create
hookurl: http://11.111.111.111:2222
user: '{{ gituser }}'
oauthkey: '{{ oauthkey }}'
repo: https://api.github.com/repos/pcgentry/Github-Auto-Deploy
# Cleaning all hooks for this repo that had an error on the last update. Since this works for all hooks in a repo it is probably best that this would
# be called from a handler.
- github_hooks:
action: cleanall
user: '{{ gituser }}'
oauthkey: '{{ oauthkey }}'
repo: '{{ repo }}'
delegate_to: localhost
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/github_hooks_module.html