66 lines
2.7 KiB
Python
66 lines
2.7 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright © 2014 Zulip, Inc.
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
# THE SOFTWARE.
|
|
|
|
|
|
# Change these values to configure authentication for the plugin
|
|
ZULIP_USER = "git-bot@example.com"
|
|
ZULIP_API_KEY = "0123456789abcdef0123456789abcdef"
|
|
|
|
# commit_notice_destination() lets you customize where commit notices
|
|
# are sent to with the full power of a Python function.
|
|
#
|
|
# It takes the following arguments:
|
|
# * repo = the name of the git repository
|
|
# * branch = the name of the branch that was pushed to
|
|
# * commit = the commit id
|
|
#
|
|
# Returns a dictionary encoding the stream and subject to send the
|
|
# notification to (or None to send no notification).
|
|
#
|
|
# The default code below will send every commit pushed to "master" to
|
|
# * stream "commits"
|
|
# * topic "master"
|
|
# And similarly for branch "test-post-receive" (for use when testing).
|
|
def commit_notice_destination(repo, branch, commit):
|
|
if branch in ["master", "test-post-receive"]:
|
|
return dict(stream = "commits",
|
|
subject = u"%s" % (branch,))
|
|
|
|
# Return None for cases where you don't want a notice sent
|
|
return None
|
|
|
|
# Modify this function to change how commits are displayed; the most
|
|
# common customization is to include a link to the commit in your
|
|
# graphical repository viewer, e.g.
|
|
#
|
|
# return '!avatar(%s) [%s](https://example.com/commits/%s)\n' % (author, subject, commit_id)
|
|
def format_commit_message(author, subject, commit_id):
|
|
return '!avatar(%s) %s\n' % (author, subject)
|
|
|
|
## If properly installed, the Zulip API should be in your import
|
|
## path, but if not, set a custom path below
|
|
ZULIP_API_PATH = None
|
|
|
|
# If you're using Zulip Voyager, set this to your Zulip Voyager server
|
|
ZULIP_SITE = "https://api.zulip.com"
|