zulip/templates/zerver/integrations/codebase.md

37 lines
1.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

First, create the streams youd like to use for Codebase notifications. There
will be two types of messages: commit-related updates and issue-related updates.
After creating these streams (we suggest naming them `codebase commits` and
`codebase issues`), make sure to subscribe all interested parties.
{!download-python-bindings.md!}
You will need your Codebase API Username. You can find it in the settings page
of your account, under **API Credentials**.
{!change-zulip-config-file.md!}
Also, edit the following Codebase credentials in `zulip_codebase_config.py`:
```
CODEBASE_API_USERNAME = "zulip-inc/leo-franchi-15"
CODEBASE_API_KEY = 0123456789abcdef0123456789abcdef
```
Before your first run of the script, you may optionally choose to configure it
to mirror some number of hours of prior Codebase activity:
```
CODEBASE_INITIAL_HISTORY_HOURS = 10
```
Now, simply run the `api/integrations/codebase/zulip_codebase_mirror` script.
If needed, this script may be restarted, and it will automatically resume from
when it was last running.
Whenever you create a new project, commit, issue, deployment, or more, youll
get notifications in your selected streams with the associated information.
{!congrats.md!}
![](/static/images/integrations/codebase/001.png)