Changes between Version 1 and Version 2 of TracRepositoryAdmin
- Timestamp:
- 02/06/14 17:20:59 (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracRepositoryAdmin
v1 v2 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 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. 10 10 11 11 == Specifying repositories == #Repositories … … 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. … … 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.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. 44 43 {{{ 45 44 #!ini … … 49 48 project.type = svn 50 49 project.url = http://example.com/svn/project 50 project.hidden = true 51 51 52 lib.dir = /var/repos/lib 52 53 lib.description = This is the secondary library code. 53 54 lib.type = svn 54 55 lib.url = http://example.com/svn/lib 56 55 57 .alias = project 56 .hidden = true57 58 }}} 58 59 Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around. … … 85 86 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 87 88 === Mercurial Repositories === 89 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. 90 87 91 === Explicit synchronization === #ExplicitSync 88 92 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. … … 96 100 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 97 101 102 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. 103 98 104 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 105 {{{#!sh 101 106 #!/bin/sh 107 export PYTHON_EGG_CACHE="/path/to/dir" 102 108 /usr/bin/trac-admin /path/to/env changeset added "$1" "$2" 103 109 }}} 110 Note: Ubuntu doesn't seem to like /usr/bin/trac-admin, so just use: 111 {{{#!sh 112 #!/bin/sh 113 export PYTHON_EGG_CACHE="/path/to/dir" 114 trac-admin /path/to/env/ changeset added "$1" "$2" 115 }}} 104 116 On Windows (`post-commit.cmd`): 105 {{{ 106 #!application/x-dos-batch 117 {{{#!application/x-dos-batch 107 118 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2" 108 119 }}} 109 120 110 121 The post-revprop-change hook for Subversion is very similar. On Unix (`post-revprop-change`): 111 {{{ 112 #!sh 122 {{{#!sh 113 123 #!/bin/sh 124 export PYTHON_EGG_CACHE="/path/to/dir" 114 125 /usr/bin/trac-admin /path/to/env changeset modified "$1" "$2" 115 126 }}} 116 127 On Windows (`post-revprop-change.cmd`): 117 {{{ 118 #!application/x-dos-batch 128 {{{#!application/x-dos-batch 119 129 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2" 120 130 }}} 121 131 132 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`. 133 122 134 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 135 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. 136 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. 137 138 Git hooks can be used in the same way for explicit syncing of git repositories. Add the following to `.git/hooks/post-commit`: 139 {{{#!sh 140 REV=$(git rev-parse HEAD) 141 trac-admin /path/to/env changeset added <my-repository> $REV 142 }}} 143 144 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): 145 {{{#!ini 146 [hooks] 147 ; If mercurial-plugin is installed globally 148 commit = python:tracext.hg.hooks.add_changesets 149 changegroup = python:tracext.hg.hooks.add_changesets 150 151 ; If mercurial-plugin is installed in a Trac plugins directory 152 commit = python:/path/to/hooks.py:add_changesets 153 changegroup = python:/path/to/hooks.py:add_changesets 154 155 [trac] 156 env = /path/to/env 157 trac-admin = /path/to/trac-admin 158 }}} 125 159 126 160 === Per-request synchronization === #PerRequestSync … … 130 164 131 165 132 == Migration from a single-repository setup == #Migration133 The following procedure illustrates a typical migration from a single-repository setup to multiple repositories.166 == Migration from a single-repository setup (Subversion) == #Migration 167 The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories. 134 168 135 169 1. Remove the default repository specification from the `[trac] repository_dir` option. 136 1. Add the "main"repository as a named repository.170 1. Add the main repository as a named repository. 137 171 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. 172 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. 173 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. 174 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed. 175 176 == Migration from a single-repository setup (Mercurial) == #MigrationMercurial 177 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. 178 179 1. Upgrade to the latest version of the TracMercurial plugin. 180 1. Remove the default repository specification from the `[trac] repository_dir` option. 181 1. Add the main repository as a named repository. 182 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. 183 1. Repeat step 3 to add other "named" repositories as needed. 141 184 142 185 == Troubleshooting ==