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

integration-docs: Update Git for new doc format. 

Part of zulip#29592.
This commit is contained in:
Niloth P 2024-11-14 17:34:07 +05:30
parent a89096970a
commit cd692bdc74
1 changed files with 17 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
templates/zerver/integrations/git.md
View File

@ -1,5 +1,9 @@
# Zulip Git integration
Get Zulip notifications for your Git repositories! Get Zulip notifications for your Git repositories!
{start_tabs}
1. {!create-an-incoming-webhook.md!} 1. {!create-an-incoming-webhook.md!}
1. {!download-python-bindings.md!} 1. {!download-python-bindings.md!}
@ -8,12 +12,16 @@ Get Zulip notifications for your Git repositories!
1. {!change-zulip-config-file.md!} 1. {!change-zulip-config-file.md!}
You may also need to change the value of `STREAM_NAME`. ```
STREAM_NAME = "<Name of your channel>"
```
You can specify the branches that will be used for notifications by modifying !!! tip ""
the `commit_notice_destination` function. By default,
pushes to the `main`, `master`, and `test-post-receive` branches will result in a Customize notification branches by editing the
notification. `commit_notice_destination` function. By default,
pushes to the `main`, `master`, and `test-post-receive` branches will
result in a notification.
1. Symlink `/usr/local/share/zulip/integrations/git/zulip_git_config.py` 1. Symlink `/usr/local/share/zulip/integrations/git/zulip_git_config.py`
to the `.git/hooks` directory of your Git repository. to the `.git/hooks` directory of your Git repository.
@ -23,8 +31,10 @@ Get Zulip notifications for your Git repositories!
!!! tip "" !!! tip ""
You can test the plugin without changing your `main` branch by Use the `test-post-receive` branch to safely test the plugin without
pushing to the `test-post-receive` branch. modifying your main branch.
{end_tabs}
{!congrats.md!} {!congrats.md!}