| 6 | | * Manage repositories in the "Repository" admin panel, with `trac-admin` or in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini]. |
| 7 | | * Set up a call to `trac-admin $ENV changeset added $REPO $REV` in the post-commit hook of each repository. Additionally, add a call to `trac-admin $ENV changeset modified $REPO $REV` in the post-revprop-change hook of repositories allowing revision property changes. |
| 8 | | * Set the `[trac] repository_sync_per_request` option to an empty value to disable per-request syncing. |
| 9 | | * Make sure the user under which your Subversion hooks are run has write access to the Trac environment, or use a tool like `sudo` to temporarily elevate privileges. |
| | 6 | Trac is primarily used as an issue tracking and project planning system, but can also be used to connect to and maintain source code repositories. This page describes the guidelines and caveats when connecting Trac to a repository. |
| | 7 | * Enable the repository connector(s) for the version control system(s) that you will use. |
| | 8 | * Add repositories through the //Repositories// admin page, using `trac-admin` or by editing the `[repositories]` section of [[wiki:TracIni#repositories-section|trac.ini]]. |
| | 9 | * Synchronize the repositories with the cache, if using cached repositories. |
| | 10 | * Configure your repository hooks to synchronize the repository. Alternatively you can synchronize on every request or disable the use of cached repositories, both of which have performance drawbacks and reduced functionality, but are easier to configure. |
| | 11 | |
| | 12 | == Enabling the components |
| | 13 | |
| | 14 | Support for version control systems is provided by optional components distributed with Trac, which are disabled by default. Subversion and Git must be explicitly enabled if you wish to use them. |
| | 15 | |
| | 16 | 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 through the //Plugins// admin page. |
| | 17 | |
| | 18 | {{{#!ini |
| | 19 | tracopt.versioncontrol.svn.* = enabled |
| | 20 | }}} |
| | 21 | |
| | 22 | {{{#!ini |
| | 23 | tracopt.versioncontrol.git.* = enabled |
| | 24 | }}} |
| 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: |
| | 27 | |
| | 28 | Trac supports multiple repositories per environment, and the repositories may be for different version control systems. Each repository must be defined in a repository configuration provider. Repository providers included with Trac are the [#ReposDatabase database store], the [#ReposTracIni trac.ini configuration file] and the [#ReposGitWeb GitWeb configuration file]. Additional providers are available as plugins. |
| | 29 | |
| | 30 | You can define your repositories through a mix of providers, but each repository should only be defined in a single provider. The repository names must be unique across all providers and duplicate names are discarded. |
| | 31 | |
| | 32 | 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. |
| | 33 | |
| | 34 | === Default Repository |
| | 35 | |
| | 36 | Trac's repositories are listed in the Repository Index when navigating to //Browse Source//. The default repository is displayed first, followed by the Repository Index. TracLinks without a repository name in the path specification (e.g. `[1]` rather than `[1/repos1]`) refer to the default repository. !TracLinks for repositories other than the default must include the repository name in the path specification. |
| | 37 | |
| | 38 | From the Repository Admin page, the default repository is specified by leaving the //Name// attribute empty. From the command line, the default repository is specified using the string `(default)` or `""`. In TracIni, the default repository is specified by leaving the `{name}` empty for each `{name}.{attribute}` option (e.g. `.dir = /path/to/dir`). |
| | 39 | |
| | 40 | === Repository Attributes |
| | 41 | |
| | 42 | A repository is defined through the attribute `name` and one of the `alias` or `dir` attributes, all other attributes are optional: |
| 24 | | ||The `dir` attribute specifies the location of the repository in the filesystem. It corresponds to the value previously specified in the option `[trac] repository_dir`. The `alias` and `dir` attributes are mutually exclusive. || |
| 25 | | ||`hidden` ||When set to `true`, the repository is hidden from the repository index page in the source browser. Browsing the repository is still possible, and links referencing the repository remain valid. || |
| 26 | | ||`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. || |
| 27 | | ||`url` ||The `url` attribute specifies the root URL to be used for checking out from the repository. When specified, a "Repository URL" link is added to the context navigation links in the source browser, that can be copied into the tool used for creating the working copy. || |
| 28 | | |
| 29 | | A repository `name` and one of `alias` or `dir` attributes are mandatory. All others are optional. |
| 30 | | |
| 31 | | After adding a repository, the cache for that repository must be re-synchronized once with the `trac-admin $ENV repository resync` command. |
| 32 | | |
| 33 | | `repository resync <repos>`:: |
| 34 | | Re-synchronize Trac with a repository. |
| 35 | | |
| | 52 | || Specifies the location of the repository in the filesystem. The `alias` and `dir` attributes are mutually exclusive. || |
| | 53 | ||`hidden` ||\ |
| | 54 | || When set to `true`, the repository is hidden from the repository index page in the source browser. Browsing the repository is still possible, and links referencing the repository remain valid. || |
| | 55 | ||`name` ||\ |
| | 56 | || Identifies the version control system used by the repository. This field is mandatory. || |
| | 57 | ||`sync_per_request`||\ |
| | 58 | || When set to `true` the repository will be synchronized on every request (implicit synchronization). This is generally not recommended. See [#Synchronization repository synchronization] for a comparison of explicit and implicit synchronization. The attribute defaults to `false`. || |
| | 59 | ||`type` ||\ |
| | 60 | || Specifies the version control system used by the repository. Trac provides support for Subversion and Git, and plugins add support for several other systems. If `type` is not specified, it defaults to the value of the `[versioncontrol]` [wiki:TracIni#versioncontrol-default_repository_type-option default_repository_type] option. || |
| | 61 | ||`url` ||\ |
| | 62 | || Specifies the root URL to be used for checking out from the repository. When specified, a "Repository URL" link is added to the context navigation links in the source browser, that can be copied into the tool used for creating the working copy. || |
| | 63 | |
| | 64 | Additional attributes may be available through plugins. |
| | 65 | |
| | 66 | === Scoped Repository |
| | 67 | |
| | 68 | For some version control systems, it is possible to specify not only the path to the repository in the `dir` attribute, but also a ''scope'' within the repository. Trac will then only show information related to the files and changesets below that scope. The scope is specified by appending a path that is relative to the repository root. The Subversion backend for Trac supports this. |
| | 69 | |
| | 70 | For example, assume a repository at filesystem path `/var/svn/repos1` with several directories at the root of the repository: `/proj1`, `/proj2`, etc. The following configuration would scope the repository to `/proj1`: |
| | 71 | {{{#!ini |
| | 72 | proj1.dir = /var/svn/repos1/proj1 |
| | 73 | proj1.type = svn |
| | 74 | }}} |
| | 75 | |
| | 76 | For other repository types, check the corresponding plugin's documentation. |
| | 77 | |
| | 78 | === In the database #ReposDatabase |
| | 79 | Repositories can also be specified in the database, using either the //Repositories// admin page under //Version Control//, or the `trac-admin $ENV repository` commands. |
| | 80 | |
| | 81 | The admin panel shows the list of all repositories defined in the Trac environment. It allows adding repositories and aliases, editing repository attributes and removing repositories. Note that repositories defined in `trac.ini` are displayed but cannot be edited. |
| | 82 | |
| | 83 | The following [wiki:TracAdmin trac-admin] commands can be used to perform repository operations from the command line. |
| | 84 | |
| | 85 | `repository add <repos> <dir> [type]`:: |
| | 86 | Add a repository `<repos>` located at `<dir>`, and optionally specify its type. |
| | 87 | |
| | 88 | `repository alias <name> <target>`:: |
| | 89 | Create an alias `<name>` for the repository `<target>`. |
| | 90 | |
| | 91 | `repository remove <repos>`:: |
| | 92 | Remove the repository `<repos>`. |
| | 93 | |
| | 94 | `repository set <repos> <key> <value>`:: |
| | 95 | Set the attribute `<key>` to `<value>` for the repository `<repos>`. |
| | 96 | |
| | 97 | Note that the default repository has an empty name, so it will need to be quoted when running `trac-admin` from a shell. Alternatively, the name `(default)` can be used instead, for example when running `trac-admin` in interactive mode. |
| 60 | | === In the database #ReposDatabase |
| 61 | | Repositories can also be specified in the database, using either the "Repositories" admin panel under "Version Control", or the `trac-admin $ENV repository` commands. |
| 62 | | |
| 63 | | The admin panel shows the list of all repositories defined in the Trac environment. It allows adding repositories and aliases, editing repository attributes and removing repositories. Note that repositories defined in `trac.ini` are displayed but cannot be edited. |
| 64 | | |
| 65 | | The following [wiki:TracAdmin trac-admin] commands can be used to perform repository operations from the command line. |
| 66 | | |
| 67 | | `repository add <repos> <dir> [type]`:: |
| 68 | | Add a repository `<repos>` located at `<dir>`, and optionally specify its type. |
| 69 | | |
| 70 | | `repository alias <name> <target>`:: |
| 71 | | Create an alias `<name>` for the repository `<target>`. |
| 72 | | |
| 73 | | `repository remove <repos>`:: |
| 74 | | Remove the repository `<repos>`. |
| 75 | | |
| 76 | | `repository set <repos> <key> <value>`:: |
| 77 | | Set the attribute `<key>` to `<value>` for the repository `<repos>`. |
| 78 | | |
| 79 | | Note that the default repository has an empty name, so it will likely need to be quoted when running `trac-admin` from a shell. Alternatively, the name "`(default)`" can be used instead, for example when running `trac-admin` in interactive mode. |
| | 122 | === In !GitWeb #ReposGitWeb |
| | 123 | |
| | 124 | [https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb GitWeb] is a CGI script that comes with Git for web-based visualization of repositories. Trac can read the gitweb-formatted `project.lists` file. The configuration is done through the `[gitweb-repositories]` section of [[TracIni#gitweb-repositories-section|trac.ini]]. |
| 83 | | The Subversion and Git repository connectors support caching, which improves the performance browsing the repository, viewing logs and viewing changesets. Cached repositories must be [#Synchronization synchronized]; either explicit or implicit synchronization can be used. When searching changesets, only cached repositories are searched. |
| 84 | | |
| 85 | | Subversion repositories are cached unless the type is `direct-svnfs`. Git repositories are cached when `[git]` [wiki:TracIni#git-section cached_repository] is `true`. |
| | 128 | Caching improves the performance browsing the repository, viewing logs and viewing changesets. Cached repositories must be [#Synchronization synchronized], using either explicit or implicit synchronization. When searching changesets, only cached repositories are searched. |
| | 129 | |
| | 130 | The Subversion and Git backends support caching. The [trac:TracMercurial Mercurial plugin] does not yet support caching ([trac:#8417]). To disable caching, set the `cached` attribute to `false`. |
| | 131 | |
| | 132 | After adding a cached repository, the cache must be populated with the `trac-admin $ENV repository resync` command. |
| | 133 | |
| | 134 | `repository resync <repos>`:: |
| | 135 | Re-synchronize Trac with a repository. |
| | 156 | |
| | 157 | ===== Using `trac-svn-hook` |
| | 158 | |
| | 159 | In a Unix environment, the simplest way to configure explicit synchronization is by using the [trac:source:branches/1.4-stable/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. |
| | 160 | |
| | 161 | There's no equivalent `trac-svn-hook.bat` for Windows yet, but the script can be run by Cygwin's bash. The documentation header of `trac-svn-hook` contains a Cygwin configuration example. |
| | 162 | |
| | 163 | Follow the help in the documentation header of the script to configure `trac-svn-hook`. You'll need to minimally set the `TRAC_ENV` variable, and may also need to set `TRAC_PATH` and `TRAC_LD_LIBRARY_PATH` for a non-standard installation or a virtual environment. |
| | 164 | |
| | 165 | Configuring the hook environment variables is even easier in Subversion 1.8 and later 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, or exporting them from the hook that invokes `trac-svn-hook`, they can be configured through the repository `conf/hooks-env` file. |
| | 166 | |
| | 167 | Here is an example, using a Python virtual environment at `/usr/local/venv`: |
| | 168 | {{{#!ini |
| | 169 | [default] |
| | 170 | TRAC_ENV=/var/trac/project-1 |
| | 171 | TRAC_PATH=/usr/local/venv/bin |
| | 172 | }}} |
| | 173 | |
| | 174 | ===== Writing Your Own Hook Script |
| 141 | | 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): |
| 142 | | {{{#!sh |
| 143 | | #!/bin/sh |
| 144 | | REV=$(git rev-parse HEAD) |
| 145 | | trac-admin /path/to/env changeset added <repos> $REV |
| 146 | | }}} |
| 147 | | |
| 148 | | Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo: |
| 149 | | {{{#!sh |
| 150 | | #!/bin/sh |
| 151 | | tracenv=/path/to/env # change with your Trac environment's path |
| 152 | | repos= # change with your repository's name |
| | 205 | [https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks Git hooks] can be used in the same way for explicit syncing of Git repositories. |
| | 206 | |
| | 207 | If your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo: |
| | 208 | {{{#!sh |
| | 209 | #!/bin/sh |
| | 210 | tracenv=/path/to/env # set to your Trac environment's path |
| | 211 | repos= # set to your repository's name |
| 161 | | |
| 162 | | The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. |
| | 220 | The `repos` variable is the repository name (use `"(default)"` for the default repository). |
| | 221 | |
| | 222 | Alternatively, 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 repository: |
| | 223 | {{{#!sh |
| | 224 | #!/bin/sh |
| | 225 | tracenv=/path/to/env # set to your Trac environment's path |
| | 226 | repos= # set to your repository's name |
| | 227 | REV=$(git rev-parse HEAD) |
| | 228 | trac-admin "$tracenv" changeset added "$repos" $REV |
| | 229 | }}} |
| | 230 | The `post-commit` hook will do nothing if you only update the repository by pushing to it. |
| | 231 | |
| | 232 | Be sure to set the hook scripts as executable. |
| 183 | | 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. |
| 184 | | |
| 185 | | Note that in this case, the changeset listener extension point is not called, and therefore plugins using it will not work correctly. |
| 186 | | |
| 187 | | |
| 188 | | == Automatic changeset references in tickets |
| 189 | | |
| 190 | | 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: |
| | 253 | If the post-commit hooks are not available, the environment can be set up for per-request synchronization. The `sync_per_request` attribute for each repository in the database and in [wiki:TracIni#trac-section trac.ini] must be set to `true`. |
| | 254 | |
| | 255 | Note that in this case, the changeset listener extension point is not called, and therefore plugins that depend on the changeset added and modified events won't work correctly. For example, automatic changeset references cannot be used with implicit synchronization. |
| | 256 | |
| | 257 | == Automatic changeset references in tickets #CommitTicketUpdater |
| | 258 | |
| | 259 | 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 patterns: |
| 200 | | == Migration from a single-repository setup (Subversion) #Migration |
| 201 | | The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories. |
| 202 | | |
| 203 | | 1. Remove the default repository specification from the `[trac] repository_dir` option. |
| 204 | | 1. Add the main repository as a named repository. |
| 205 | | 1. Re-synchronize the main repository. |
| 206 | | 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. |
| 207 | | 1. Add an alias to the main repository as the default repository (by leaving out the the `name`, e.g. `.alias = main`). This ensures that all links predating the migration still resolve to the main repository. |
| 208 | | 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed. |
| 209 | | |
| 210 | | == Migration from a single-repository setup (Mercurial) #MigrationMercurial |
| 211 | | The following procedure illustrates a typical migration from a Mercurial single-repository setup to multiple repositories. Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:ticket:9485 #9485] for more information. |
| 212 | | |
| 213 | | 1. Upgrade to the latest version of the [trac:TracMercurial] plugin. |
| 214 | | 1. Remove the default repository specification from the `[trac] repository_dir` option. |
| 215 | | 1. Add the main repository as a named repository. |
| 216 | | 1. Add an alias to the main repository as the default repository (by leaving out the the `name`, e.g. `.alias = main`). This ensures that all links predating the migration still resolve to the main repository. |
| 217 | | 1. Repeat step 3 to add other "named" repositories as needed. |
| 218 | | |
