Skip to content

Commit 7ebfe41

Browse files
committed
integration-docs: Update the SVN integration doc.
1 parent 3a2c96e commit 7ebfe41

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

zulip/integrations/svn/doc.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,43 @@
1-
It is easy to send Zulips on SVN commits, by configuring a
2-
post-commit hook. To do this:
1+
# Zulip Subversion Integration
32

4-
1. {!create-channel.md!}
3+
Get Zulip notifications for your {{ integration_display_name }} commits, by
4+
configuring a `post-commit` hook!
55

6-
1. {!download-python-bindings.md!}
6+
{start_tabs}
77

8-
1. Install `pysvn`. On Linux, you can install the `python-svn`
9-
package. On other platforms, you can install a binary or from
10-
source by following the [instructions on the pysvn website][1].
8+
1. {!create-an-incoming-webhook.md!}
119

12-
[1]: http://pysvn.tigris.org/project_downloads.html
10+
1. {!download-python-bindings.md!}
1311

14-
1. {!change-zulip-config-file.md!}
12+
1. {!install-requirements.md!}
1513

16-
1. Copy `integrations/svn/zulip_svn_config.py` and
17-
`integrations/svn/post-commit` from the API bindings directory
18-
to the `hooks` subdirectory of your SVN repository.
14+
1. If your {{ integration_display_name }} server and your Zulip server are
15+
on the same machine, symlink the `post-commit` hook of your
16+
{{ integration_display_name }} repository in your
17+
{{ integration_display_name }} server by running:
1918

20-
1. The default stream used by this post-commit hook is `commits`; if
21-
you’d prefer a different stream, change it now in
22-
`zulip_svn_config.py`. Make sure that everyone interested in getting
23-
these post-commit Zulips is subscribed to that stream!
19+
`ln -s {{ integration_path }}/post-commit your-repo/hooks/post-commit`
20+
21+
Otherwise, copy the `post-commit` hook to your
22+
{{ integration_display_name }} repository's `/hooks` directory.
23+
24+
The `post-commit` hook is triggered after every commit.
25+
26+
1. {!change-zulip-config-file.md!}
27+
28+
1. Copy the config file to the same directory as the `post-commit` hook.
29+
30+
`cp {{ config_file_path }} your-repo/hooks`
31+
32+
{end_tabs}
2433

2534
{!congrats.md!}
2635

2736
![SVN commit bot message](/static/images/integrations/svn/001.png)
37+
38+
### Configuration options
39+
40+
You can configure the channel and topic where notifications are sent by
41+
updating the `commit_notice_destination` function in
42+
`{{ config_file_path }}`. By default, notifications are sent to a topic
43+
named after the repository, in the "commits" channel.

0 commit comments

Comments
 (0)