zulip/templates/zerver/integrations/git.md

Zulip Git integration

Get Zulip notifications for your Git repositories!

{start_tabs}

1. {!create-an-incoming-webhook.md!}

2. {!download-python-bindings.md!}

3. {!create-channel.md!}

4. {!change-zulip-config-file.md!}

   STREAM_NAME = "<Name of your channel>"
   

   !!! tip ""

    Customize notification branches by editing the
    `commit_notice_destination` function. By default,
    pushes to the `main`, `master`, and `test-post-receive` branches will
    result in a notification.
   

5. Symlink /usr/local/share/zulip/integrations/git/zulip_git_config.py to the .git/hooks directory of your Git repository.

6. Symlink /usr/local/share/zulip/integrations/git/post-receive to the .git/hooks directory of your Git repository.

!!! tip ""

Use the `test-post-receive` branch to safely test the plugin without
modifying your main branch.

{end_tabs}

{!congrats.md!}