| 8 | | * Set the `[trac] repository_sync_per_request` option to an empty value to disable per-request syncing. |
| 9 | | |
| 10 | | |
| 11 | | == Specifying repositories == #Repositories |
| 12 | | Starting with 0.12, Trac can handle more than one repository per environment. The pre-0.12 way of specifying the repository with the `repository_dir` and `repository_type` options in the `[trac]` section of [wiki:TracIni trac.ini] is still supported, but two new mechanisms allow including additional repositories into an environment. |
| 13 | | |
| 14 | | It is also possible to define aliases of repositories, that act as "pointers" to real repositories. This can be useful when renaming a repository, to avoid breaking all the links to the old name. |
| 15 | | |
| 16 | | A number of attributes can be associated with each repository, which define the repository's location, type, name and how it is displayed in the source browser. The following attributes are supported: |
| | 9 | * Make sure the user under which your hooks are run has write access to the Trac environment, or use a tool like `sudo` to temporarily elevate privileges. |
| | 10 | |
| | 11 | == Enabling the components |
| | 12 | |
| | 13 | Support for version control systems is provided by optional components distributed with Trac, which are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. |
| | 14 | |
| | 15 | The version control systems can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the //Plugins// admin panel. |
| | 16 | |
| | 17 | {{{#!ini |
| | 18 | tracopt.versioncontrol.svn.* = enabled |
| | 19 | }}} |
| | 20 | |
| | 21 | {{{#!ini |
| | 22 | tracopt.versioncontrol.git.* = enabled |
| | 23 | }}} |
| | 24 | |
| | 25 | == Specifying repositories #Repositories |
| | 26 | Trac supports multiple repositories per environment, and the repositories may be for different version control system types. Each repository must be defined in a repository configuration provider, the two supported by default are the [#ReposDatabase database store] and the [#ReposTracIni trac.ini configuration file]. A repository should not be defined in multiple configuration providers. |
| | 27 | |
| | 28 | It is possible to define aliases of repositories, that act as "pointers" to real repositories. This can be useful when renaming a repository, to avoid breaking links to the old name. |
| | 29 | |
| | 30 | A number of attributes can be associated with each repository. The attributes define the repository's location, type, name and how it is displayed in the source browser. The following attributes are supported: |
| 26 | | ||`name` ||The `name` attribute specifies the leading path element to the repository. || |
| 27 | | ||`type` ||The `type` attribute sets the type of version control system used by the repository. Trac supports Subversion |
| | 40 | ||`sync_per_request`||When set to `true` the repository will be synced on every request. This is not recommended, instead a post-commit hook should be configured to provide [#ExplicitSync explicit synchronization] and `sync_per_request` should be set to `false`.|| |
| | 41 | ||`type` ||The `type` attribute sets the type of version control system used by the repository. Trac supports Subversion and Git out-of-the-box, and plugins add support for many other systems. If `type` is not specified, it defaults to the value of the `[trac] repository_type` option. || |
| 87 | | === Explicit synchronization === #ExplicitSync |
| 88 | | This is the preferred method of repository synchronization. It requires setting the `[trac] repository_sync_per_request` option in [wiki:TracIni#trac-section trac.ini] to an empty value, and adding a call to `trac-admin` in the post-commit hook of each repository. Additionally, if a repository allows changing revision metadata, a call to `trac-admin` must be added to the post-revprop-change hook as well. |
| | 109 | === Mercurial Repositories |
| | 110 | Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:#9485] for more information. |
| | 111 | |
| | 112 | === Explicit synchronization #ExplicitSync |
| | 113 | This is the preferred method of repository synchronization. It requires setting the `sync_per_request` attribute to `false`, and adding a call to `trac-admin` in the `post-commit` hook of each repository. Additionally, if a repository allows changing revision metadata, a call to `trac-admin` must be added to the `post-revprop-change` hook as well. |
| | 123 | Note that you may have to set the environment variable `PYTHON_EGG_CACHE` to the same value as was used for the web server configuration before calling `trac-admin`, if you changed it from its default location. See [wiki:TracPlugins Trac Plugins] for more information. |
| | 124 | |
| | 125 | ==== Subversion |
| | 126 | |
| | 127 | ===== Using `trac-svn-hook` |
| | 128 | |
| | 129 | In a Unix environment, the simplest way to configure explicit synchronization is by using the [trac:source:trunk/contrib/trac-svn-hook contrib/trac-svn-hook] script. `trac-svn-hook` starts `trac-admin` asynchronously to avoid slowing the commit and log editing operations. The script comes with a number of safety checks and usage advice. Output is written to a log file with prefix `svn-hooks-` in the environment `log` directory, which can make configuration issues easier to debug. |
| | 130 | |
| | 131 | There's no equivalent `trac-svn-hook.bat` for Windows yet, but the script can be run by Cygwin's bash. |
| | 132 | |
| | 133 | Follow the help in the documentation header of the script to configure `trac-svn-hook`. Configuring the hook environment variables is made easier in Subversion 1.8 by using the [http://svnbook.red-bean.com/en/1.8/svn.reposadmin.create.html#svn.reposadmin.hooks.configuration hook script environment] configuration. Rather than directly editing `trac-svn-hook` to set the environment variables, they can be configured through the repository `conf/hooks-env` file. Replace the [trac:source:trunk/contrib/trac-svn-hook@:65-67#L61 configuration section] with: |
| | 134 | {{{#!bash |
| | 135 | export PATH=$PYTHON_BIN:$PATH |
| | 136 | export LD_LIBRARY_PATH=$PYTHON_LIB:$LD_LIBRARY_PATH |
| | 137 | }}} |
| | 138 | and set the variables `TRAC_ENV`, `PYTHON_BIN` and `PYTHON_LIB` in the `hooks-env` file. Here is an example, using a Python virtual environment at `/usr/local/venv`: |
| | 139 | {{{#!ini |
| | 140 | [default] |
| | 141 | TRAC_ENV=/var/trac/project-1 |
| | 142 | PYTHON_BIN=/usr/local/venv/bin |
| | 143 | PYTHON_LIB=/usr/local/venv/lib |
| | 144 | }}} |
| | 145 | |
| | 146 | ===== Writing Your Own Hook Script |
| | 147 | |
| 122 | | Note that calling `trac-admin` in your Subversion hooks can slow down the commit and log editing operations on the client side. You might want to use the [trac:source:trunk/contrib/trac-svn-hook contrib/trac-svn-hook] script which starts `trac-admin` in an asynchronous way. The script also comes with a number of safety checks and usage advices which should make it easier to set up and test your hooks. There's no equivalent `trac-svn-hook.bat` for Windows yet, but the script can be run by Cygwin's bash. |
| 123 | | |
| 124 | | See the [http://svnbook.red-bean.com/en/1.5/svn.reposadmin.create.html#svn.reposadmin.create.hooks section about hooks] in the Subversion book for more information. Other repository types will require different hook setups. Please see the plugin documentation for specific instructions. |
| 125 | | |
| 126 | | === Per-request synchronization === #PerRequestSync |
| 127 | | If the post-commit hooks are not available, the environment can be set up for per-request synchronization. In that case, the `[trac] repository_sync_per_request` option in [wiki:TracIni#trac-section trac.ini] must be set to a comma-separated list of repository names to be synchronized. |
| | 171 | The Unix variants above assume that the user running the Subversion commit has write access to the Trac environment, which is the case in the standard configuration where both the repository and Trac are served by the web server. If you access the repository through another means, for example `svn+ssh://`, you may have to run `trac-admin` with different privileges, for example by using `sudo`. |
| | 172 | |
| | 173 | See the [http://svnbook.red-bean.com/en/1.7/svn.reposadmin.create.html#svn.reposadmin.create.hooks section about hooks] in the Subversion book for more information. Other repository types will require different hook setups. |
| | 174 | |
| | 175 | ==== Git |
| | 176 | |
| | 177 | Git hooks can be used in the same way for explicit syncing of Git repositories. If your git repository is one that gets committed to directly on the machine that hosts trac, add the following to the `hooks/post-commit` file in your git repo (note: this will do nothing if you only update the repo by pushing to it): |
| | 178 | {{{#!sh |
| | 179 | #!/bin/sh |
| | 180 | REV=$(git rev-parse HEAD) |
| | 181 | trac-admin /path/to/env changeset added <repos> $REV |
| | 182 | }}} |
| | 183 | |
| | 184 | Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo: |
| | 185 | {{{#!sh |
| | 186 | #!/bin/sh |
| | 187 | tracenv=/path/to/env # change with your Trac environment's path |
| | 188 | repos= # change with your repository's name |
| | 189 | while read oldrev newrev refname; do |
| | 190 | if [ "$oldrev" = 0000000000000000000000000000000000000000 ]; then |
| | 191 | git rev-list --reverse "$newrev" -- |
| | 192 | else |
| | 193 | git rev-list --reverse "$newrev" "^$oldrev" -- |
| | 194 | fi | xargs trac-admin "$tracenv" changeset added "$repos" |
| | 195 | done |
| | 196 | }}} |
| | 197 | |
| | 198 | The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. |
| | 199 | |
| | 200 | ==== Mercurial |
| | 201 | |
| | 202 | For Mercurial, add the following entries to the `.hgrc` file of each repository accessed by Trac (if [trac:TracMercurial] is installed in a Trac `plugins` directory, download [trac:source:mercurial-plugin/tracext/hg/hooks.py hooks.py] and place it somewhere accessible): |
| | 203 | {{{#!ini |
| | 204 | [hooks] |
| | 205 | ; If mercurial-plugin is installed globally |
| | 206 | commit = python:tracext.hg.hooks.add_changesets |
| | 207 | changegroup = python:tracext.hg.hooks.add_changesets |
| | 208 | |
| | 209 | ; If mercurial-plugin is installed in a Trac plugins directory |
| | 210 | commit = python:/path/to/hooks.py:add_changesets |
| | 211 | changegroup = python:/path/to/hooks.py:add_changesets |
| | 212 | |
| | 213 | [trac] |
| | 214 | env = /path/to/env |
| | 215 | trac-admin = /path/to/trac-admin |
| | 216 | }}} |
| | 217 | |
| | 218 | === Per-request synchronization #PerRequestSync |
| | 219 | If the post-commit hooks are not available, the environment can be set up for per-request synchronization. In that case, the `sync_per_request` attribute for each repository in the database and in [wiki:TracIni#trac-section trac.ini] must be set to `false`. |
| 131 | | |
| 132 | | == Migration from a single-repository setup == #Migration |
| 133 | | The following procedure illustrates a typical migration from a single-repository setup to multiple repositories. |
| 134 | | |
| 135 | | 1. Remove the default repository specification from the `[trac] repository_dir` option. |
| 136 | | 1. Add the "main" repository as a named repository. |
| 137 | | 1. Re-synchronize the main repository. |
| 138 | | 1. Set up post-commit and post-revprop-change hooks on the main repository, and set `[trac] repository_sync_per_request` to an empty value. |
| 139 | | 1. Add a hidden alias to the main repository as the default repository. This ensures that all links predating the migration still resolve to the main repository. |
| 140 | | 1. Repeat steps 2, 3 and 4 to add other (named) repositories as needed. |
| 141 | | |
| 142 | | == Troubleshooting == |
| 143 | | |
| 144 | | === My trac-post-commit-hook doesn't work anymore === #trac-post-commit-hook |
| | 223 | == Automatic changeset references in tickets |
| | 224 | |
| | 225 | You can automatically add a reference to the changeset as a ticket comment whenever changes are committed to the repository. The description of the commit needs to contain one of the following formulas: |
| | 226 | * '''`Refs #123`''' - to reference this changeset in `#123` ticket |
| | 227 | * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' |
| | 228 | |
| | 229 | This functionality requires installing a post-commit hook as described in [#ExplicitSync], and enabling the optional commit updater components by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini], or enabling the components in the //Plugins// admin panel. |
| | 230 | {{{#!ini |
| | 231 | tracopt.ticket.commit_updater.* = enabled |
| | 232 | }}} |
| | 233 | For more information, see the documentation of the `CommitTicketUpdater` component in the //Plugins// admin panel and the [trac:CommitTicketUpdater] page. |
| | 234 | |
| | 235 | == Troubleshooting |
| | 236 | |
| | 237 | === My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook |
