diff --git a/docs/docs/user_manual/subversion.md b/docs/docs/user_manual/subversion.md new file mode 100644 index 0000000..7c56711 --- /dev/null +++ b/docs/docs/user_manual/subversion.md @@ -0,0 +1,23 @@ +# Subversion Integration + +By hooking your Subversion server to Attract, tasks can be automatically updated based on tags in +the commit message. This requires a post-commit hook to be installed on the Subversion server. + +Example hook: + + REPOS="$1" + REV="$2" + TXN_NAME="$3" + + /usr/bin/python "$REPOS"/hooks/notify_attract.py "$REPOS" "$REV" + +The +[`notify_attract.py`](https://developer.blender.org/source/attract/browse/master/notify_attract.py) +file is bundled with Attract's source code, and needs to be copied to the Subversion repository's +`hook` directory. After copying, modify the code to include an authentication token and the mapping from the Subversion repository name to the project URL. For example: + + AUTH_TOKEN = 'SRVxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' + PILLAR_URL = 'https://cloud.blender.org/' + PROJECT_URLS = { # Mapping from SVN repository name to Attract project URL. + 'svnreponame': 'p-123456789', + } diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index af94881..919f724 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -28,6 +28,7 @@ pages: - User Manual: - 'user_manual/introduction.md' - 'user_manual/installation.md' + - 'user_manual/subversion.md' - Developer Docs: - 'developer_docs/roadmap.md'