github_hooks – Manages GitHub service hooks.
github_hooks – Manages GitHub service hooks.
New in version 1.4.
Synopsis
- Adds service hooks and removes service hooks that have an error status.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
action - / required |
|
This tells the githooks module what you want it to do. |
content_type - |
|
Content type to use for requests made to the webhook |
hookurl - |
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 - / required |
The oauth key provided by GitHub. It can be found/generated on GitHub under "Edit Your Profile" >> "Developer settings" >> "Personal Access Tokens" | |
repo - / required |
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 - / required |
Github username. | |
validate_certs boolean |
|
If |
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 not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Phillip Gentry, CX Inc (@pcgentry)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/github_hooks_module.html