diff options
Diffstat (limited to 'modules/github')
| -rw-r--r-- | modules/github/__init__.py | 758 | ||||
| -rw-r--r-- | modules/github/ghwebhook.md | 53 |
2 files changed, 0 insertions, 811 deletions
diff --git a/modules/github/__init__.py b/modules/github/__init__.py deleted file mode 100644 index 46106a91..00000000 --- a/modules/github/__init__.py +++ /dev/null @@ -1,758 +0,0 @@ -#--depends-on channel_access -#--depends-on check_mode -#--depends-on commands -#--depends-on config -#--depends-on permissions -#--depends-on rest_api - -import datetime, itertools, json, math, re, urllib.parse -from src import EventManager, ModuleManager, utils - -COLOR_BRANCH = utils.consts.ORANGE -COLOR_REPO = utils.consts.GREY -COLOR_POSITIVE = utils.consts.GREEN -COLOR_NEUTRAL = utils.consts.LIGHTGREY -COLOR_NEGATIVE = utils.consts.RED -COLOR_ID = utils.consts.PINK - -FORM_ENCODED = "application/x-www-form-urlencoded" - -COMMIT_URL = "https://github.com/%s/commit/%s" -COMMIT_RANGE_URL = "https://github.com/%s/compare/%s...%s" -CREATE_URL = "https://github.com/%s/tree/%s" - -API_ISSUE_URL = "https://api.github.com/repos/%s/%s/issues/%s" -API_PULL_URL = "https://api.github.com/repos/%s/%s/pulls/%s" - -DEFAULT_EVENT_CATEGORIES = [ - "ping", "code", "pr", "issue", "repo" -] -EVENT_CATEGORIES = { - "ping": [ - "ping" # new webhook received - ], - "code": [ - "push", "commit_comment" - ], - "pr-minimal": [ - "pull_request/opened", "pull_request/closed", "pull_request/reopened" - ], - "pr": [ - "pull_request/opened", "pull_request/closed", "pull_request/reopened", - "pull_request/edited", "pull_request/assigned", - "pull_request/unassigned", "pull_request_review", - "pull_request_review_comment" - ], - "pr-all": [ - "pull_request", "pull_request_review", "pull_request_review_comment" - ], - "pr-review-minimal": [ - "pull_request_review/submitted", "pull_request_review/dismissed" - ], - "pr-review-comment-minimal": [ - "pull_request_review_comment/created", - "pull_request_review_comment/deleted" - ], - "issue-minimal": [ - "issues/opened", "issues/closed", "issues/reopened", "issues/deleted" - ], - "issue": [ - "issues/opened", "issues/closed", "issues/reopened", "issues/deleted", - "issues/edited", "issues/assigned", "issues/unassigned", "issue_comment" - ], - "issue-all": [ - "issues", "issue_comment" - ], - "issue-comment-minimal": [ - "issue_comment/created", "issue_comment/deleted" - ], - "repo": [ - "create", # a repository, branch or tag has been created - "delete", # same as above but deleted - "release", - "fork" - ], - "team": [ - "membership" - ], - "star": [ - # "watch" is a misleading name for this event so this add "star" as an - # alias for "watch" - "watch" - ] -} - -COMMENT_ACTIONS = { - "created": "commented", - "edited": "edited a comment", - "deleted": "deleted a comment" -} - -CHECK_RUN_CONCLUSION = { - "success": "passed", - "failure": "failed", - "neutral": "finished", - "cancelled": "was cancelled", - "timed_out": "timed out", - "action_required": "requires action" -} -CHECK_RUN_FAILURES = ["failure", "cancelled", "timed_out", "action_required"] - -@utils.export("channelset", {"setting": "github-hide-prefix", - "help": "Hide/show command-like prefix on Github hook outputs", - "validate": utils.bool_or_none, "example": "on"}) -@utils.export("channelset", {"setting": "github-hide-organisation", - "help": "Hide/show organisation in repository names", - "validate": utils.bool_or_none, "example": "on"}) -@utils.export("channelset", {"setting": "github-default-repo", - "help": "Set the default github repo for the current channel", - "example": "jesopo/bitbot"}) -@utils.export("channelset", {"setting": "github-prevent-highlight", - "help": "Enable/disable preventing highlights", - "validate": utils.bool_or_none, "example": "on"}) -@utils.export("channelset", {"setting": "auto-github", - "help": "Enable/disable automatically getting github issue/PR info", - "validate": utils.bool_or_none, "example": "on"}) -@utils.export("channelset", {"setting": "auto-github-cooldown", - "help": "Set amount of seconds between auto-github duplicates", - "validate": utils.int_or_none, "example": "300"}) -class Module(ModuleManager.BaseModule): - def _parse_ref(self, channel, ref): - repo, _, number = ref.rpartition("#") - org, _, repo = repo.partition("/") - - default_repo = channel.get_setting("github-default-repo", "") - default_org, _, default_repo = default_repo.partition("/") - - if org and not repo: - repo = org or default_repo - org = default_org - else: - org = org or default_org - repo = repo or default_repo - - if not org or not repo or not number: - raise utils.EventError("Please provide username/repo#number") - if not number.isdigit(): - raise utils.EventError("Issue number must be a number") - return org, repo, number - - def _parse_issue(self, page, username, repository, number): - repo = utils.irc.color("%s/%s" % (username, repository), COLOR_REPO) - number = utils.irc.color("#%s" % number, COLOR_ID) - labels = [label["name"] for label in page.data["labels"]] - labels_str = "" - if labels: - labels_str = "[%s] " % ", ".join(labels) - - url = self._short_url(page.data["html_url"]) - - state = page.data["state"] - if state == "open": - state = utils.irc.color("open", COLOR_NEUTRAL) - elif state == "closed": - state = utils.irc.color("closed", COLOR_NEGATIVE) - - return "(%s issue%s, %s) %s %s%s" % ( - repo, number, state, page.data["title"], labels_str, url) - def _get_issue(self, username, repository, number): - return utils.http.request( - API_ISSUE_URL % (username, repository, number), - json=True) - - @utils.hook("received.command.ghissue", min_args=1) - def github_issue(self, event): - if event["target"].get_setting("github-hide-prefix", False): - event["stdout"].hide_prefix() - event["stderr"].hide_prefix() - - username, repository, number = self._parse_ref( - event["target"], event["args_split"][0]) - - page = self._get_issue(username, repository, number) - if page and page.code == 200: - self._parse_issue(page, username, repository, number) - else: - event["stderr"].write("Could not find issue") - - def _parse_pull(self, page, username, repository, number): - repo = utils.irc.color("%s/%s" % (username, repository), COLOR_REPO) - number = utils.irc.color("#%s" % number, COLOR_ID) - branch_from = page.data["head"]["label"] - branch_to = page.data["base"]["label"] - added = self._added(page.data["additions"]) - removed = self._removed(page.data["deletions"]) - url = self._short_url(page.data["html_url"]) - - state = page.data["state"] - if page.data["merged"]: - state = utils.irc.color("merged", COLOR_POSITIVE) - elif state == "open": - state = utils.irc.color("open", COLOR_NEUTRAL) - elif state == "closed": - state = utils.irc.color("closed", COLOR_NEGATIVE) - - return "(%s PR%s, %s) %s → %s [%s/%s] %s %s" % ( - repo, number, state, branch_from, branch_to, added, removed, - page.data["title"], url) - def _get_pull(self, username, repository, number): - return utils.http.request( - API_PULL_URL % (username, repository, number), - json=True) - @utils.hook("received.command.ghpull", min_args=1) - def github_pull(self, event): - if event["target"].get_setting("github-hide-prefix", False): - event["stdout"].hide_prefix() - event["stderr"].hide_prefix() - - username, repository, number = self._parse_ref( - event["target"], event["args_split"][0]) - page = self._get_pull(username, repository, number) - - if page and page.code == 200: - self._parse_pull(page, username, repository, number) - else: - event["stderr"].write("Could not find pull request") - - def _get_info(self, target, ref): - username, repository, number = self._parse_ref(target, ref) - page = self._get_issue(username, repository, number) - if page and page.code == 200: - if "pull_request" in page.data: - pull = self._get_pull(username, repository, number) - return self._parse_pull(pull, username, repository, number) - else: - return self._parse_issue(page, username, repository, number) - else: - return None - - @utils.hook("received.command.gh", alias_of="github") - @utils.hook("received.command.github", min_args=1) - def github(self, event): - if event["target"].get_setting("github-hide-prefix", False): - event["stdout"].hide_prefix() - event["stderr"].hide_prefix() - result = self._get_info(event["target"], event["args_split"][0]) - if not result == None: - event["stdout"].write(result) - else: - event["stderr"].write("Issue/PR not found") - - def _cache_ref(self, ref): - return "auto-github-%s" % ref.lower() - def _auto_github_cooldown(self, channel, ref): - cooldown = channel.get_setting("auto-github-cooldown", None) - if not cooldown == None: - cache = self._cache_ref(ref) - if not self.bot.cache.has_item(cache): - self.bot.cache.temporary_cache(cache, cooldown) - return True - else: - return False - else: - return True - - @utils.hook("command.regex", ignore_action=False) - def url_regex(self, event): - """ - :command: github - :pattern: https?://github.com/([^/]+)/([^/]+)/(pull|issues)/(\d+) - """ - if event["target"].get_setting("auto-github", False): - event.eat() - ref = "%s/%s#%s" % (event["match"].group(1), - event["match"].group(2), event["match"].group(4)) - if self._auto_github_cooldown(event["target"], ref): - try: - result = self._get_info(event["target"], ref) - except utils.EventError: - return - if result: - if event["target"].get_setting("github-hide-prefix", False): - event["stdout"].hide_prefix() - event["stdout"].write(result) - - @utils.hook("command.regex", ignore_action=False) - def ref_regex(self, event): - """ - :command: github - :pattern: (?:\S+(?:\/\S+)?)?#\d+ - """ - if event["target"].get_setting("auto-github", False): - event.eat() - ref = event["match"].group(0) - if self._auto_github_cooldown(event["target"], ref): - try: - result = self._get_info(event["target"], - event["match"].group(0)) - except utils.EventError: - return - if result: - if event["target"].get_setting("github-hide-prefix", False): - event["stdout"].hide_prefix() - event["stdout"].write(result) - - @utils.hook("received.command.ghwebhook", min_args=1, channel_only=True) - def github_webhook(self, event): - """ - :help: Add/remove/modify a github webhook - :require_mode: high - :require_access: github-webhook - :permission: githuboverride - :usage: list - :usage: add <hook> - :usage: remove <hook> - :usage: events <hook> [category [category ...]] - :usage: branches <hook> [branch [branch ...]] - """ - all_hooks = event["target"].get_setting("github-hooks", {}) - hook_name = None - existing_hook = None - if len(event["args_split"]) > 1: - hook_name = event["args_split"][1] - for existing_hook_name in all_hooks.keys(): - if existing_hook_name.lower() == hook_name.lower(): - existing_hook = existing_hook_name - break - - subcommand = event["args_split"][0].lower() - if subcommand == "list": - event["stdout"].write("Registered web hooks: %s" % - ", ".join(all_hooks.keys())) - elif subcommand == "add": - if existing_hook: - event["stderr"].write("There's already a hook for %s" % - hook_name) - return - - all_hooks[hook_name] = { - "events": DEFAULT_EVENT_CATEGORIES.copy(), - "branches": [] - } - event["target"].set_setting("github-hooks", all_hooks) - event["stdout"].write("Added hook for %s" % hook_name) - elif subcommand == "remove": - if not existing_hook: - event["stderr"].write("No hook found for %s" % hook_name) - return - del all_hooks[existing_hook] - if all_hooks: - event["target"].set_setting("github-hooks", all_hooks) - else: - event["target"].del_setting("github-hooks") - event["stdout"].write("Removed hook for %s" % hook_name) - elif subcommand == "events": - if not existing_hook: - event["stderr"].write("No hook found for %s" % hook_name) - return - - if len(event["args_split"]) < 3: - event["stdout"].write("Events for hook %s: %s" % - (hook_name, " ".join(all_hooks[existing_hook]["events"]))) - else: - new_events = [e.lower() for e in event["args_split"][2:]] - all_hooks[existing_hook]["events"] = new_events - event["target"].set_setting("github-hooks", all_hooks) - event["stdout"].write("Updated events for hook %s" % hook_name) - elif subcommand == "branches": - if not existing_hook: - event["stderr"].write("No hook found for %s" % hook_name) - return - - if len(event["args_split"]) < 3: - branches = ",".join(all_hooks[existing_hook]["branches"]) - event["stdout"].write("Branches shown for hook %s: %s" % - (hook_name, branches)) - else: - all_hooks[existing_hook]["branches"] = event["args_split"][2:] - event["target"].set_setting("github-hooks", all_hooks) - event["stdout"].write("Updated shown branches for hook %s" % - hook_name) - else: - event["stderr"].write("Unknown command '%s'" % - event["args_split"][0]) - - @utils.hook("api.post.github") - def webhook(self, event): - payload = event["data"].decode("utf8") - if event["headers"]["Content-Type"] == FORM_ENCODED: - payload = urllib.parse.unquote(urllib.parse.parse_qs(payload)[ - "payload"][0]) - data = json.loads(payload) - - github_event = event["headers"]["X-GitHub-Event"] - - full_name = None - repo_username = None - repo_name = None - if "repository" in data: - full_name = data["repository"]["full_name"] - repo_username, repo_name = full_name.split("/", 1) - - organisation = None - if "organization" in data: - organisation = data["organization"]["login"] - - event_action = None - if "action" in data: - event_action = "%s/%s" % (github_event, data["action"]) - - branch = None - if "ref" in data: - _, _, branch = data["ref"].rpartition("/") - - hooks = self.bot.database.channel_settings.find_by_setting( - "github-hooks") - targets = [] - - repo_hooked = False - for server_id, channel_name, hooked_repos in hooks: - found_hook = None - if full_name and full_name in hooked_repos: - found_hook = hooked_repos[full_name] - elif repo_username and repo_username in hooked_repos: - found_hook = hooked_repos[repo_username] - elif organisation and organisation in hooked_repos: - found_hook = hooked_repos[organisation] - - if found_hook: - repo_hooked = True - server = self.bot.get_server_by_id(server_id) - if server and channel_name in server.channels: - if (branch and - found_hook["branches"] and - not branch in found_hook["branches"]): - continue - - github_events = [] - for hooked_event in found_hook["events"]: - github_events.append(EVENT_CATEGORIES.get( - hooked_event, [hooked_event])) - github_events = list(itertools.chain(*github_events)) - - channel = server.channels.get(channel_name) - if (github_event in github_events or - (event_action and event_action in github_events)): - targets.append([server, channel]) - - if not targets: - if not repo_hooked: - return None - else: - return {"state": "success", "deliveries": 0} - - outputs = None - if github_event == "push": - outputs = self.push(full_name, data) - elif github_event == "commit_comment": - outputs = self.commit_comment(full_name, data) - elif github_event == "pull_request": - outputs = self.pull_request(full_name, data) - elif github_event == "pull_request_review": - outputs = self.pull_request_review(full_name, data) - elif github_event == "pull_request_review_comment": - outputs = self.pull_request_review_comment(full_name, data) - elif github_event == "issue_comment": - outputs = self.issue_comment(full_name, data) - elif github_event == "issues": - outputs = self.issues(full_name, data) - elif github_event == "create": - outputs = self.create(full_name, data) - elif github_event == "delete": - outputs = self.delete(full_name, data) - elif github_event == "release": - outputs = self.release(full_name, data) - elif github_event == "check_run": - outputs = self.check_run(data) - elif github_event == "fork": - outputs = self.fork(full_name, data) - elif github_event == "ping": - outputs = self.ping(data) - elif github_event == "membership": - outputs = self.membership(organisation, data) - elif github_event == "watch": - outputs = self.watch(data) - - - if outputs: - for server, channel in targets: - source = full_name or organisation - hide_org = channel.get_setting( - "github-hide-organisation", False) - if repo_name and hide_org: - source = repo_name - - for output in outputs: - output = "(%s) %s" % ( - utils.irc.color(source, COLOR_REPO), output) - - if channel.get_setting("github-prevent-highlight", False): - output = self._prevent_highlight(server, channel, - output) - - self.events.on("send.stdout").call(target=channel, - module_name="Github", server=server, message=output, - hide_prefix=channel.get_setting( - "github-hide-prefix", False)) - - return {"state": "success", "deliveries": len(targets)} - - def _prevent_highlight(self, server, channel, s): - for user in channel.users: - if len(user.nickname) == 1: - # if we don't ignore 1-letter nicknames, the below while loop - # will fire indefininitely. - continue - - regex = re.compile(r"(.)\b(%s)(%s)" % ( - re.escape(user.nickname[0]), re.escape(user.nickname[1:])), - re.I) - s = regex.sub("\\1\\2\u200c\\3", s) - - return s - - def _short_url(self, url): - try: - page = utils.http.request("https://git.io", method="POST", - post_data={"url": url}) - return page.headers["Location"] - except utils.http.HTTPTimeoutException: - self.log.warn( - "HTTPTimeoutException while waiting for github short URL", []) - return url - - def _iso8601(self, s): - return datetime.datetime.strptime(s, utils.ISO8601_PARSE) - - def ping(self, data): - return ["Received new webhook"] - - def _change_count(self, n, symbol, color): - return utils.irc.color("%s%d" % (symbol, n), color)+utils.irc.bold("") - def _added(self, n): - return self._change_count(n, "+", COLOR_POSITIVE) - def _removed(self, n): - return self._change_count(n, "-", COLOR_NEGATIVE) - def _modified(self, n): - return self._change_count(n, "~", utils.consts.PURPLE) - - def _short_hash(self, hash): - return hash[:8] - - def _flat_unique(self, commits, key): - return set(itertools.chain(*(commit[key] for commit in commits))) - - def push(self, full_name, data): - outputs = [] - branch = data["ref"].split("/", 2)[2] - branch = utils.irc.color(branch, COLOR_BRANCH) - author = utils.irc.bold(data["pusher"]["name"]) - - forced = "" - if data["forced"]: - forced = "%s " % utils.irc.color("force", utils.consts.RED) - - if len(data["commits"]) == 0 and data["forced"]: - outputs.append( - "%s %spushed to %s" % (author, forced, branch)) - elif len(data["commits"]) <= 3: - for commit in data["commits"]: - hash = commit["id"] - hash_colored = utils.irc.color(self._short_hash(hash), COLOR_ID) - message = commit["message"].split("\n")[0].strip() - url = self._short_url(COMMIT_URL % (full_name, hash)) - - outputs.append( - "%s %spushed %s to %s: %s - %s" - % (author, forced, hash_colored, branch, message, url)) - else: - first_id = data["before"] - last_id = data["commits"][-1]["id"] - url = self._short_url( - COMMIT_RANGE_URL % (full_name, first_id, last_id)) - - outputs.append("%s %spushed %d commits to %s - %s" - % (author, forced, len(data["commits"]), branch, url)) - - return outputs - - - def commit_comment(self, full_name, data): - action = data["action"] - commit = self._short_hash(data["comment"]["commit_id"]) - commenter = utils.irc.bold(data["comment"]["user"]["login"]) - url = self._short_url(data["comment"]["html_url"]) - return ["[commit/%s] %s %s a comment - %s" % (commit, commenter, - action, url)] - - def pull_request(self, full_name, data): - number = utils.irc.color("#%s" % data["pull_request"]["number"], - COLOR_ID) - action = data["action"] - action_desc = "%s %s" % (action, number) - branch = data["pull_request"]["base"]["ref"] - colored_branch = utils.irc.color(branch, COLOR_BRANCH) - - if action == "opened": - action_desc = "requested %s merge into %s" % (number, - colored_branch) - elif action == "closed": - if data["pull_request"]["merged"]: - action_desc = "%s %s into %s" % ( - utils.irc.color("merged", COLOR_POSITIVE), number, - colored_branch) - else: - action_desc = "%s %s" % ( - utils.irc.color("closed", COLOR_NEGATIVE), number) - elif action == "ready_for_review": - action_desc = "marked %s ready for review" % number - elif action == "synchronize": - action_desc = "committed to %s" % number - - pr_title = data["pull_request"]["title"] - author = utils.irc.bold(data["sender"]["login"]) - url = self._short_url(data["pull_request"]["html_url"]) - return ["[PR] %s %s: %s - %s" % ( - author, action_desc, pr_title, url)] - - def pull_request_review(self, full_name, data): - if not data["action"] == "submitted": - return [] - - if not "submitted_at" in data["review"]: - return [] - - state = data["review"]["state"] - if state == "commented": - return [] - - number = utils.irc.color("#%s" % data["pull_request"]["number"], - COLOR_ID) - action = data["action"] - pr_title = data["pull_request"]["title"] - reviewer = utils.irc.bold(data["sender"]["login"]) - url = self._short_url(data["review"]["html_url"]) - - state_desc = state - if state == "approved": - state_desc = "approved changes" - elif state == "changes_requested": - state_desc = "requested changes" - elif state == "dismissed": - state_desc = "dismissed a review" - - return ["[PR] %s %s on %s: %s - %s" % - (reviewer, state_desc, number, pr_title, url)] - - def pull_request_review_comment(self, full_name, data): - number = utils.irc.color("#%s" % data["pull_request"]["number"], - COLOR_ID) - action = data["action"] - pr_title = data["pull_request"]["title"] - sender = utils.irc.bold(data["sender"]["login"]) - url = self._short_url(data["comment"]["html_url"]) - return ["[PR] %s %s on a review on %s: %s - %s" % - (sender, COMMENT_ACTIONS[action], number, pr_title, url)] - - def issues(self, full_name, data): - number = utils.irc.color("#%s" % data["issue"]["number"], COLOR_ID) - action = data["action"] - issue_title = data["issue"]["title"] - author = utils.irc.bold(data["sender"]["login"]) - url = self._short_url(data["issue"]["html_url"]) - return ["[issue] %s %s %s: %s - %s" % - (author, action, number, issue_title, url)] - def issue_comment(self, full_name, data): - if "changes" in data: - # don't show this event when nothing has actually changed - if data["changes"]["body"]["from"] == data["comment"]["body"]: - return - - number = utils.irc.color("#%s" % data["issue"]["number"], COLOR_ID) - action = data["action"] - issue_title = data["issue"]["title"] - type = "PR" if "pull_request" in data["issue"] else "issue" - commenter = utils.irc.bold(data["sender"]["login"]) - url = self._short_url(data["comment"]["html_url"]) - return ["[%s] %s %s on %s: %s - %s" % - (type, commenter, COMMENT_ACTIONS[action], number, issue_title, - url)] - - def create(self, full_name, data): - ref = data["ref"] - ref_color = utils.irc.color(ref, COLOR_BRANCH) - type = data["ref_type"] - sender = utils.irc.bold(data["sender"]["login"]) - url = self._short_url(CREATE_URL % (full_name, ref)) - return ["%s created a %s: %s - %s" % (sender, type, ref_color, url)] - - def delete(self, full_name, data): - ref = data["ref"] - ref_color = utils.irc.color(ref, COLOR_BRANCH) - type = data["ref_type"] - sender = utils.irc.bold(data["sender"]["login"]) - return ["%s deleted a %s: %s" % (sender, type, ref_color)] - - def release(self, full_name, data): - action = data["action"] - tag = data["release"]["tag_name"] - name = data["release"]["name"] or "" - if name: - name = ": %s" % name - author = utils.irc.bold(data["release"]["author"]["login"]) - url = self._short_url(data["release"]["html_url"]) - return ["%s %s a release%s - %s" % (author, action, name, url)] - - def check_run(self, data): - name = data["check_run"]["name"] - commit = self._short_hash(data["check_run"]["head_sha"]) - commit = utils.irc.color(commit, utils.consts.LIGHTBLUE) - - url = "" - if data["check_run"]["details_url"]: - url = data["check_run"]["details_url"] - url = " - %s" % self.exports.get_one("shortlink")(url) - - duration = "" - if data["check_run"]["completed_at"]: - started_at = self._iso8601(data["check_run"]["started_at"]) - completed_at = self._iso8601(data["check_run"]["completed_at"]) - if completed_at > started_at: - seconds = (completed_at-started_at).total_seconds() - duration = " in %s" % utils.to_pretty_time(seconds) - - status = data["check_run"]["status"] - status_str = "" - if status == "queued": - status_str = utils.irc.bold("queued") - elif status == "in_progress": - status_str = utils.irc.bold("started") - elif status == "completed": - conclusion = data["check_run"]["conclusion"] - conclusion_color = COLOR_POSITIVE - if conclusion in CHECK_RUN_FAILURES: - conclusion_color = COLOR_NEGATIVE - if conclusion == "neutral": - conclusion_color = COLOR_NEUTRAL - - status_str = utils.irc.color( - CHECK_RUN_CONCLUSION[conclusion], conclusion_color) - - return ["[build @%s] %s: %s%s%s" % ( - commit, name, status_str, duration, url)] - - def fork(self, full_name, data): - forker = utils.irc.bold(data["sender"]["login"]) - fork_full_name = utils.irc.color(data["forkee"]["full_name"], - utils.consts.LIGHTBLUE) - url = self._short_url(data["forkee"]["html_url"]) - return ["%s forked into %s - %s" % - (forker, fork_full_name, url)] - - def membership(self, organisation, data): - return ["%s %s %s to team %s" % - (data["sender"]["login"], data["action"], data["member"]["login"], - data["team"]["name"])] - - def watch(self, data): - return ["%s starred the repository" % data["sender"]["login"]] diff --git a/modules/github/ghwebhook.md b/modules/github/ghwebhook.md deleted file mode 100644 index f533cc81..00000000 --- a/modules/github/ghwebhook.md +++ /dev/null @@ -1,53 +0,0 @@ -# !ghwebhook - -## List registered web hooks -`!ghwebhook list` - -## Adding a web hook - -`!ghwebhook add [name]` where `[name]` is either a full repository name (e.g. `jesopo/bitbot`) to get a specific repository or a user/organisation name (e.g. `jesopo`) to get all repositories for that user/organisation - -## Removing a web hook -Same as above but with `remove` instead of `add` - -## Modifying shown events -`!ghwebhook events [hook] [events]` where `[hook]` is the `[name]` used in the `add` command and where `[events]` is a space-separated list of either raw events (see [here](https://developer.github.com/v3/activity/events/types/)) or the following (default: "ping code pr issue repo") - -#### ping -Shows when a newly registered web hook first hits BitBot - -#### code -Shows for commits and comments on commits - -#### pr-minimal -Shows minimal pull request actions; opened, closed, reopened - -#### pr -Shows the same actions as `pr-minimal` and also: edited, assigned, unassigned, review requests, comments on review requests - -#### pr-all -Shows the same actions as `pr` and also: labeled, unlabeled, new commits - -#### issue-minimal -Shows minimal issue actions; opened, closed, reopened, deleted - -#### issue -Shows the same actions as `issue-minimal` and also: edited, assigned, unassigned, comments on issues - -#### issue-all -Shows the same actions as `issue` and also: transferred, pinned, unpinned, labeled, unlabeled, milestoned, demilestoned - -#### repo -Shows events related repositories themselves; repository/branch/tag created, repository/branch/tag deleted, release created, fork created - -#### team -Shows when users are added or removed from teams - -## List shown events -`!ghwebhook events [hook]` - -## Modify shown branches -`!ghwebhook branches [hook] [branches]` where `[hook]` is the `[name]` used in the `add` command and where `[branches]` is a space-separated list of branch names - -## List shown branches -`!ghwebhook branches [hook]` |