Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

webhooks/github: Migrate docs to Markdown.

This commit is contained in:
Eeshan Garg 2017-06-04 21:23:04 -02:30 committed by Tim Abbott
parent 7cfc592202
commit 0cfe089152
2 changed files with 44 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
zerver/webhooks/github/doc.html
View File

@ -1,53 +0,0 @@
<p>
This webhook bases on deprecated concept that is
<a href="https://github.com/github/github-services">GitHub Services</a>
</p>
<p>
First, create the stream you'd like to use for GitHub notifications,
and subscribe all interested parties to this stream. The integration will
use the default stream <code>commits</code> if no stream is supplied in
the hook; you still need to create the stream even if you are using this
default.
</p>
<p>Next, go to your repository page and click <b>"Settings"</b>:</p>
<p><img src="/static/images/integrations/github/001.png"/></p>
<p>From there, select <b>"Webhooks &amp; Services"</b>:</p>
<p><img src="/static/images/integrations/github/002.png"/></p>
<p>To find the Zulip hook, you have to click on <b>Configure services</b>.</p>
<p><img class="screenshot" src="/static/images/integrations/github/003.png"/></p>
<p>
Select <b>"Zulip"</b> from the list of service hooks. Fill in
the API key and email address for your bot and check
the <b>"active"</b> checkbox. Specify
<code>{{ external_api_uri_subdomain }}/v1/external/github</code> as the <b>"Alternative
endpoint"</b>. You can optionally supply the Zulip stream (the
default is <code>commits</code>) and restrict Zulip
notifications to a specified set of branches.
</p>
<p>
Further configuration is possible. By default, commits traffic (pushes, commit comments),
GitHub issues traffic, and pull requests are enabled. You can exclude certain types of traffic
via the checkboxes. If you want commit traffic, issue traffic, and pull requests to go to
different places, you can use the <b>Commit Stream</b> and <b>Issue Stream</b> overrides;
otherwise, it is safe to leave these fields blank and just have it default to the <b>Stream</b>
setting.
</p>
<p>
Click the <b>"Update settings"</b> button to complete the
configuration:
</p>
<p><img src="/static/images/integrations/github/004.png"/></p>
<p>
<b>Congratulations! You're done!</b><br/> When team members push to
your repository, you'll get a Zulip notification that looks like this:
</p>
<p><img class="screenshot" src="/static/images/integrations/github/005.png"/></p>

44
zerver/webhooks/github/doc.md Normal file
View File

@ -0,0 +1,44 @@
This webhook is based on the deprecated
[GitHub Services](https://github.com/github/github-services).
{!create-stream.md!}
However, the integration will use the default stream `commits`
if no stream is supplied in the hook; you still need to create
the stream even if you are using this default.
Next, go to your repository page and click **Settings**:
![](/static/images/integrations/github/001.png)
From there, select **Webhooks & Services**:
![](/static/images/integrations/github/002.png)
To find the Zulip hook, you have to click on **Configure services**.
![](/static/images/integrations/github/003.png)
Select **Zulip** from the list of service hooks. Fill in the API key
and email address for your bot that you created earlier and check
the **"active"** checkbox. Specify
`{{ external_api_uri_subdomain }}/v1/external/github` as the
**Alternative endpoint**. You can optionally supply the Zulip stream
(the default is `commits`) and restrict Zulip notifications to a
specified set of branches.
Further configuration is possible. By default, commits traffic
(pushes, commit comments), GitHub issues traffic, and pull requests
are enabled. You can exclude certain types of traffic via the checkboxes.
If you want commit traffic, issue traffic, and pull requests to go to
different places, you can use the **Commit Stream** and **Issue Stream**
overrides; otherwise, it is safe to leave these fields blank and just
have it default to the **Stream** setting.
Click the **Update settings** button to complete the configuration:
![](/static/images/integrations/github/004.png)
{!congrats.md!}
![](/static/images/integrations/github/005.png)