mirror of
https://github.com/zulip/zulip.git
synced 2025-11-06 15:03:34 +00:00
620854d437
Several integration docs instruct the user to create a bot, but don't specify that the type of bot should be "Incoming webhook". Renames create-a-bot.md -> create-an-incoming-webhook.md for clarity, and replaces all incomplete instructions with this macro. Renames bot_types.png -> bot_types_incoming_webhook.png and updates the image with a screenshot of the latest UI.
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
Get Codebase notifications in Zulip!
|
||
|
||
1. First, create the streams you’d like to use for Codebase notifications. There
|
||
will be two types of messages: commit-related updates and issue-related
|
||
updates. We recommend naming the streams `codebase` and `tickets`, respectively.
|
||
After creating these streams, make sure to subscribe all interested parties.
|
||
|
||
1. {!create-an-incoming-webhook.md!}
|
||
|
||
1. {!download-python-bindings.md!}
|
||
|
||
1. {!change-zulip-config-file.md!}
|
||
|
||
You may also need to update the value of `ZULIP_TICKETS_STREAM_NAME` and
|
||
`ZULIP_COMMITS_STREAM_NAME`.
|
||
|
||
1. Go to your Codebase settings, and click on **My Profile**. Under
|
||
**API Credentials**, you will find your API key and username.
|
||
Edit the following lines in `zulip_codebase_config.py` to add your Codebase
|
||
credentials:
|
||
|
||
```
|
||
CODEBASE_API_USERNAME = "zulip-inc/leo-franchi-15"
|
||
CODEBASE_API_KEY = 0123456789abcdef0123456789abcdef
|
||
```
|
||
|
||
Before your first run of the script, you may also want to configure the
|
||
integration to mirror some number of hours of prior Codebase activity:
|
||
|
||
```
|
||
CODEBASE_INITIAL_HISTORY_HOURS = 10
|
||
```
|
||
|
||
1. Run the `/usr/local/share/zulip/integrations/codebase/zulip_codebase_mirror`
|
||
script. If needed, this script may be restarted, and it will automatically
|
||
resume from when it was last running.
|
||
|
||
{!congrats.md!}
|
||
|
||
|