Changes between Version 2 and Version 3 of TracRepositoryAdmin
- Timestamp:
- 2015-04-20T20:49:42+02:00 (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracRepositoryAdmin
v2 v3 1 = Repository Administration =1 = Repository Administration 2 2 [[PageOutline(2-3)]] 3 3 4 == Quick start ==#QuickStart4 == Quick start #QuickStart 5 5 6 6 * Manage repositories in the "Repository" admin panel, with `trac-admin` or in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini]. 7 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 8 * Set the `[trac] repository_sync_per_request` option to an empty value to disable per-request syncing. 9 10 11 == Specifying repositories ==#Repositories9 * 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. 10 11 == Specifying repositories #Repositories 12 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 13 … … 24 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 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 ||`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 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. || 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. || 28 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. || 29 28 30 The `name` attribute and one of `alias` or `dir`are mandatory. All others are optional.29 A repository `name` and one of `alias` or `dir` attributes are mandatory. All others are optional. 31 30 32 31 After adding a repository, the cache for that repository must be re-synchronized once with the `trac-admin $ENV repository resync` command. … … 36 35 37 36 38 === In `trac.ini` ===#ReposTracIni37 === In `trac.ini` #ReposTracIni 39 38 Repositories and repository attributes can be specified in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini]. Every attribute consists of a key structured as `{name}.{attribute}` and the corresponding value separated with an equal sign (`=`). The name of the default repository is empty. 40 39 41 40 The main advantage of specifying repositories in `trac.ini` is that they can be inherited from a global configuration (see the [wiki:TracIni#GlobalConfiguration global configuration] section of TracIni). One drawback is that, due to limitations in the `ConfigParser` class used to parse `trac.ini`, the repository name is always all-lowercase. 42 41 43 The following example defines two Subversion repositories named `project` and `lib`, and a hidden alias to `project` as the default repository. This is a typical use case where a Trac environment previously had a single repository (the `project` repository), and was converted to multiple repositories. The alias ensures that links predating the change continue to resolve to the `project` repository. 44 {{{ 45 #!ini 42 The following example defines two Subversion repositories named `project` and `lib`, and an alias to `project` as the default repository. This is a typical use case where a Trac environment previously had a single repository (the `project` repository), and was converted to multiple repositories. The alias ensures that links predating the change continue to resolve to the `project` repository. 43 {{{#!ini 46 44 [repositories] 47 45 project.dir = /var/repos/project … … 49 47 project.type = svn 50 48 project.url = http://example.com/svn/project 49 project.hidden = true 50 51 51 lib.dir = /var/repos/lib 52 52 lib.description = This is the secondary library code. 53 53 lib.type = svn 54 54 lib.url = http://example.com/svn/lib 55 55 56 .alias = project 56 .hidden = true57 57 }}} 58 58 Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around. 59 59 60 === In the database ===#ReposDatabase60 === In the database #ReposDatabase 61 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 62 … … 80 80 81 81 82 == Repository synchronization ==#Synchronization82 == Repository synchronization #Synchronization 83 83 Prior to 0.12, Trac synchronized its cache with the repository on every HTTP request. This approach is not very efficient and not practical anymore with multiple repositories. For this reason, explicit synchronization through post-commit hooks was added. 84 84 85 85 There is also new functionality in the form of a repository listener extension point ''(IRepositoryChangeListener)'' that is triggered by the post-commit hook when a changeset is added or modified, and can be used by plugins to perform actions on commit. 86 86 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. 87 === Mercurial Repositories 88 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. 89 90 === Explicit synchronization #ExplicitSync 91 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. 89 92 90 93 `changeset added <repos> <rev> [...]`:: … … 96 99 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 97 100 101 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. 102 103 ==== Subversion 104 98 105 The following examples are complete post-commit and post-revprop-change scripts for Subversion. They should be edited for the specific environment, marked executable (where applicable) and placed in the `hooks` directory of each repository. On Unix (`post-commit`): 99 {{{ 100 #!sh 106 {{{#!sh 101 107 #!/bin/sh 108 export PYTHON_EGG_CACHE="/path/to/dir" 102 109 /usr/bin/trac-admin /path/to/env changeset added "$1" "$2" 103 110 }}} 111 Note: Check with `whereis trac-admin`, whether `trac-admin` is really installed under `/usr/bin/` or maybe under `/usr/local/bin/` and adapt the path. 104 112 On Windows (`post-commit.cmd`): 105 {{{ 106 #!application/x-dos-batch 113 {{{#!bat 107 114 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2" 108 115 }}} 109 116 110 117 The post-revprop-change hook for Subversion is very similar. On Unix (`post-revprop-change`): 111 {{{ 112 #!sh 118 {{{#!sh 113 119 #!/bin/sh 120 export PYTHON_EGG_CACHE="/path/to/dir" 114 121 /usr/bin/trac-admin /path/to/env changeset modified "$1" "$2" 115 122 }}} 116 123 On Windows (`post-revprop-change.cmd`): 117 {{{ 118 #!application/x-dos-batch 124 {{{#!bat 119 125 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2" 120 126 }}} 121 127 128 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`. 129 122 130 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 131 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 132 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. 133 134 ==== Git 135 136 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): 137 {{{#!sh 138 #!/bin/sh 139 REV=$(git rev-parse HEAD) 140 trac-admin /path/to/env changeset added <repos> $REV 141 }}} 142 143 Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo: 144 {{{#!sh 145 #!/bin/sh 146 while read oldrev newrev refname; do 147 git rev-list --reverse $newrev ^$oldrev | \ 148 while read rev; do 149 trac-admin /path/to/env changeset added <repos> $rev 150 done 151 done 152 }}} 153 154 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 155 156 ==== Mercurial 157 158 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): 159 {{{#!ini 160 [hooks] 161 ; If mercurial-plugin is installed globally 162 commit = python:tracext.hg.hooks.add_changesets 163 changegroup = python:tracext.hg.hooks.add_changesets 164 165 ; If mercurial-plugin is installed in a Trac plugins directory 166 commit = python:/path/to/hooks.py:add_changesets 167 changegroup = python:/path/to/hooks.py:add_changesets 168 169 [trac] 170 env = /path/to/env 171 trac-admin = /path/to/trac-admin 172 }}} 173 174 === Per-request synchronization #PerRequestSync 127 175 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. 128 176 … … 130 178 131 179 132 == Migration from a single-repository setup == #Migration 133 The following procedure illustrates a typical migration from a single-repository setup to multiple repositories. 180 == Automatic changeset references in tickets 181 182 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: 183 * '''`Refs #123`''' - to reference this changeset in `#123` ticket 184 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' 185 186 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. 187 {{{#!ini 188 tracopt.ticket.commit_updater.* = enabled 189 }}} 190 For more information, see the documentation of the `CommitTicketUpdater` component in the //Plugins// admin panel and the [trac:CommitTicketUpdater] page. 191 192 == Migration from a single-repository setup (Subversion) #Migration 193 The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories. 134 194 135 195 1. Remove the default repository specification from the `[trac] repository_dir` option. 136 1. Add the "main"repository as a named repository.196 1. Add the main repository as a named repository. 137 197 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 198 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. 199 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. 200 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed. 201 202 == Migration from a single-repository setup (Mercurial) #MigrationMercurial 203 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. 204 205 1. Upgrade to the latest version of the [trac:TracMercurial] plugin. 206 1. Remove the default repository specification from the `[trac] repository_dir` option. 207 1. Add the main repository as a named repository. 208 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. 209 1. Repeat step 3 to add other "named" repositories as needed. 210 211 == Troubleshooting 212 213 === My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook 145 214 146 215 You must now use the optional components from `tracopt.ticket.commit_updater.*`, which you can activate through the Plugins panel in the Administrative part of the web interface, or by directly modifying the [TracIni#components-section "[components]"] section in the trac.ini. Be sure to use [#ExplicitSync explicit synchronization] as explained above.
