Add github_webhook module #35813
Merged
Add github_webhook module #35813
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Feb 6, 2018
ansibot
added
community_review
|
@adrianmoisey @Akasurde @andreparames @bincyber @dj-wasabi @djmattyg007 @dsummersl @pcgentry @yeukhon As a maintainer of a module in the same namespace this new module has been submitted to, your vote counts for shipits. Please review this module and add |
samdoran
removed
the
needs_triage
stpierre
force-pushed
the
github-webhook-module
branch
from
bea696c
to
c7f4133
Compare
ansibot
added
needs_ci
|
The test |
ansibot
added
ci_verified
|
shipit |
ansibot
added
the
stale_ci
stpierre
force-pushed
the
github-webhook-module
branch
from
b4f4c95
to
4811087
Compare
|
The test |
ansibot
added
ci_verified
Akasurde
requested changes
Mar 17, 2018
| @@ -0,0 +1,240 @@ | |||
| #!/usr/bin/python | |||
| # | |||
| # Copyright: (c) Ansible Project | |||
There was a problem hiding this comment.
# Copyright: (c) 2018, Ansible Project
| DOCUMENTATION = ''' | ||
| --- | ||
| module: github_webhook | ||
| short_description: Manage Github webhooks |
| short_description: Manage Github webhooks | ||
| version_added: "2.6" | ||
| description: | ||
| - "Create and delete Github webhooks" |
There was a problem hiding this comment.
Can you please add more description here?
There was a problem hiding this comment.
What more is needed? This seems sufficient to me.
| break | ||
| except github.GithubException as err: | ||
| module.fail_json( | ||
| msg="Unable to get hooks from repository %s: %s" % to_native(err), |
There was a problem hiding this comment.
Too few format values
Unable to get hooks from repository : %s" % to_native(err)
| changed, data = create_hook(repo, module) | ||
| elif hook is not None and module.params["state"] == "absent": | ||
| hook.delete() | ||
| changed = True |
There was a problem hiding this comment.
This will always return changed even if there is failure in deleting hook.
ansibot
added
the
needs_info
ansibot
added
the
stale_review
stpierre
force-pushed
the
github-webhook-module
branch
from
7ffd423
to
a708ace
Compare
ansibot
removed
stale_ci
ansibot
added
stale_ci
stpierre
force-pushed
the
github-webhook-module
branch
from
a708ace
to
8925751
Compare
|
The test |
ansibot
added
ci_verified
github_webhook lets you easily create, update and delete Github webhooks. This is part of a two-part replacement for github_hooks, which lacks a number of important features and has a strange interface.
stpierre
force-pushed
the
github-webhook-module
branch
from
256d7b4
to
d225f39
Compare
ansibot
removed
the
ci_verified
|
@Akasurde I believe your objections have mostly been addressed. |
Akasurde
approved these changes
Nov 29, 2018
|
Need another pair of eyes to approve this. |
ansibot
added
community_review
|
I made a change by specifying |
gundalow
approved these changes
Dec 6, 2018
|
Merged into |
kbreit
pushed a commit
to kbreit/ansible
that referenced
this pull request
Jan 11, 2019
* Add github_webhook module github_webhook lets you easily create, update and delete Github webhooks. This is part of a two-part replacement for github_hooks, which lacks a number of important features and has a strange interface.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
github_webhooklets you easily create, update and delete Github webhooks.This is part of a two-part replacement for
github_hooks, which lacks a number of important features and has a strange interface.The other parts are:
github_webhook_factsmodule: Add github_webhook_facts module #35814github_hooksmodule: Deprecate the github_hooks module #49296github_hookslacks a number of important features: The ability to specify the events on which a webhook should fire; the ability to add a shared secret to a hook; the ability to create hooks that do not verify SSL against their target; and more. I considered merely updating that module to add the features needed, but the existing interface is pretty odd and would be difficult to update in a backwards-compatible way. For instance, it has a built-in feature for deleting all hooks whose last request returned 504 (action: clean504), but no way to update an existing hook, or delete a specific hook. It requires you to provide the API URL to a repository, rather than just the name of the repo (and optionally a Github API base), which requires a fair degree of familiarity with the Github API.It has other issues that are easier to fix, but still weighed in on my decision to replace rather than upgrade: it rolls its own API client layer rather than using an existing library; it appears to support both password and API token auth, but only accepts a single
oauthkeyargument, which is a misnomer in both cases.Rather than try to update it and fix all of the issues, I replaced it with two modules whose usage patterns are, I hope, much more intuitive.
ISSUE TYPE
COMPONENT NAME
github_webhook
ANSIBLE VERSION