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

webhooks/codebase: Use indented Markdown macros.

This commit is contained in:
Eeshan Garg 2017-11-24 19:36:04 -03:30 committed by Tim Abbott
parent 880fd5497a
commit 8b43e07fc5
1 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
templates/zerver/integrations/codebase.md
View File

@ -1,35 +1,35 @@
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.
After creating these streams (we suggest naming them `codebase commits` and
`codebase issues`), make sure to subscribe all interested parties.
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.
After creating these streams (we suggest naming them `codebase commits` and
`codebase issues`), make sure to subscribe all interested parties.
{!download-python-bindings.md!}
2. {!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**.
3. 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!}
4. {!change-zulip-config-file-indented.md!}
Also, edit the following Codebase credentials in `zulip_codebase_config.py`:
5. Also, edit the following Codebase credentials in `zulip_codebase_config.py`:
```
CODEBASE_API_USERNAME = "zulip-inc/leo-franchi-15"
CODEBASE_API_KEY = 0123456789abcdef0123456789abcdef
```
```
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:
6. 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
```
```
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.
7. 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, you’ll
get notifications in your selected streams with the associated information.
8. Whenever you create a new project, commit, issue, deployment, or more, you’ll
get notifications in your selected streams with the associated information.
{!congrats.md!}