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

45 lines
1.6 KiB
Markdown
Raw Normal View History

webhooks/github: Migrate docs to Markdown.
2017-06-05 01:53:04 +02:00
This webhook is based on the deprecated
[GitHub Services](https://github.com/github/github-services).
{!create-stream.md!}
github/doc.md: Use Integration.stream_name as default stream.
2017-06-12 23:52:22 +02:00
The integration will use the default stream `commits`
webhooks/github: Migrate docs to Markdown.
2017-06-05 01:53:04 +02:00
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
template context: Give better names to the URLs for the API. The "subdomain" label is redundant, to the extent it's even accurate -- this is really just the URL we want to display, which may or may not involve a subdomain. Similarly "external". The former `external_api_path_subdomain` was never a path -- it's a host, followed by a path, which together form a scheme-relative URL. I'm not quite convinced that value is actually the right thing in 2 of the 3 places we use it, but fixing that can start by giving an accurate name to the thing we have.
2017-10-30 22:04:15 +01:00
`{{ api_url }}/v1/external/github` as the
webhooks/github: Migrate docs to Markdown.
2017-06-05 01:53:04 +02:00
**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)