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

webhooks/gitlab: Migrate docs to Markdown.

This commit is contained in:
Eeshan Garg 2017-06-04 20:21:14 -02:30 committed by Tim Abbott
parent dd15b2d997
commit a12fe65166
2 changed files with 23 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
zerver/webhooks/gitlab/doc.html
View File

@ -1,39 +0,0 @@
<p>
First, create the stream you'd like to use for GitLab notifications,
and subscribe all interested parties to this stream. The integration will
use the default stream <code>gitlab</code> if no stream is supplied in
the URL; you still need to create the stream even if you are using this
default.
</p>
<p>
Next, go to your repository page and click gear icon.
From there, select <b>Webhooks</b>:
</p>
<p><img src="/static/images/integrations/gitlab/001.png"/></p>
<p>In the URL field, enter a URL constructed like this: </p>
<p><code>{{ external_api_uri_subdomain }}/v1/external/gitlab?api_key=abcdefgh&amp;stream=gitlab</code></p>
<p>
where <code>api_key</code> is the API key of your Zulip
bot.
</p>
<p>
You can also limit the notifications you receive to specific
branches by specifying them in a comma-separated list at the end
of the URL, like so:
</p>
<p><code>{{ external_api_uri_subdomain }}/v1/external/gitlab?api_key=abcdefgh&amp;stream=gitlab&amp;branches=master,development</code></p>
<p>
Select the actions that you want to result in a
Zulip notification and click <b>Add Webhook</b>.
</p>
<p>
<b>Congratulations! You're done!</b><br/>
Your messages will look like this:
</p>
<p><img class="screenshot" src="/static/images/integrations/gitlab/002.png"/></p>

23
zerver/webhooks/gitlab/doc.md Normal file
View File

@ -0,0 +1,23 @@
{!create-stream.md!}
The integration will use the default stream `gitlab` if no stream
is supplied in the URL; you still need to create the stream even
if you are using this default.
{!create-bot-construct-url.md!}
{!git-webhook-url-with-branches.md!}
Next, go to your repository page and click the gear icon. From there,
select **Webhooks**:
![](/static/images/integrations/gitlab/001.png)
In the URL field, enter a URL constructed like the one above.
Select the actions that you want to result in a Zulip notification
and click **Add Webhook**.
{!congrats.md!}
![](/static/images/integrations/gitlab/002.png)