-
-
Notifications
You must be signed in to change notification settings - Fork 392
integration-docs: Update the SVN integration doc. #871
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Niloth-p
wants to merge
1
commit into
zulip:main
Choose a base branch
from
Niloth-p:docs/svn
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,43 @@ | ||
It is easy to send Zulips on SVN commits, by configuring a | ||
post-commit hook. To do this: | ||
# Zulip Subversion Integration | ||
|
||
1. {!create-channel.md!} | ||
Get Zulip notifications for your {{ integration_display_name }} commits by | ||
configuring a `post-commit` hook! | ||
|
||
1. {!download-python-bindings.md!} | ||
{start_tabs} | ||
|
||
1. Install `pysvn`. On Linux, you can install the `python-svn` | ||
package. On other platforms, you can install a binary or from | ||
source by following the [instructions on the pysvn website][1]. | ||
1. {!create-an-incoming-webhook.md!} | ||
|
||
[1]: http://pysvn.tigris.org/project_downloads.html | ||
1. {!download-python-bindings.md!} | ||
|
||
1. {!change-zulip-config-file.md!} | ||
1. {!install-requirements.md!} | ||
|
||
1. Copy `integrations/svn/zulip_svn_config.py` and | ||
`integrations/svn/post-commit` from the API bindings directory | ||
to the `hooks` subdirectory of your SVN repository. | ||
1. If your {{ integration_display_name }} server and your Zulip server are | ||
on the same machine, symlink the `post-commit` hook of your | ||
{{ integration_display_name }} repository in your | ||
{{ integration_display_name }} server by running: | ||
|
||
1. The default stream used by this post-commit hook is `commits`; if | ||
you’d prefer a different stream, change it now in | ||
`zulip_svn_config.py`. Make sure that everyone interested in getting | ||
these post-commit Zulips is subscribed to that stream! | ||
`ln -s {{ integration_path }}/post-commit your-repo/hooks/post-commit` | ||
|
||
Otherwise, copy the `post-commit` hook to your | ||
{{ integration_display_name }} repository's `/hooks` directory. | ||
|
||
The `post-commit` hook is triggered after every commit. | ||
|
||
1. {!change-zulip-config-file.md!} | ||
|
||
1. Copy the config file to the same directory as the `post-commit` hook. | ||
|
||
`cp {{ config_file_path }} your-repo/hooks` | ||
|
||
{end_tabs} | ||
|
||
{!congrats.md!} | ||
|
||
 | ||
|
||
### Configuration options | ||
|
||
You can configure the channel and topic where notifications are sent by | ||
updating the `commit_notice_destination` function in | ||
`{{ config_file_path }}`. By default, notifications are sent to the | ||
`#commits` channel with the repository as the topic name. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.