Changes between Version 1 and Version 2 of TracRepositoryAdmin
- Timestamp:
- Nov 17, 2014, 9:39:05 PM (10 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracRepositoryAdmin
v1 v2 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. … … 89 90 90 91 === 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-changehook as well.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. 92 93 93 94 `changeset added <repos> <rev> [...]`:: … … 99 100 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 100 101 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 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 104 ==== Subversion ==== 102 105 103 106 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`): … … 107 110 /usr/bin/trac-admin /path/to/env changeset added "$1" "$2" 108 111 }}} 112 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. 109 113 On Windows (`post-commit.cmd`): 110 {{{#! application/x-dos-batch114 {{{#!bat 111 115 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2" 112 116 }}} … … 119 123 }}} 120 124 On Windows (`post-revprop-change.cmd`): 121 {{{#! application/x-dos-batch125 {{{#!bat 122 126 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2" 123 127 }}} … … 127 131 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. 128 132 129 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. 133 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. 134 135 ==== Git ==== 136 137 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-receive` file in your git repo (note: this will do nothing if you only update the repo by pushing to it): 138 {{{#!sh 139 #!/bin/sh 140 REV=$(git rev-parse HEAD) 141 trac-admin /path/to/env changeset added <repos> $REV 142 }}} 143 144 Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo: 145 {{{#!sh 146 #!/bin/sh 147 while read oldrev newrev refname; do 148 git rev-list --reverse $newrev ^$oldrev | \ 149 while read rev; do 150 trac-admin /path/to/env changeset added <repos> $rev 151 done 152 done 153 }}} 154 155 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 156 157 ==== Mercurial ==== 158 159 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): 160 {{{#!ini 161 [hooks] 162 ; If mercurial-plugin is installed globally 163 commit = python:tracext.hg.hooks.add_changesets 164 changegroup = python:tracext.hg.hooks.add_changesets 165 166 ; If mercurial-plugin is installed in a Trac plugins directory 167 commit = python:/path/to/hooks.py:add_changesets 168 changegroup = python:/path/to/hooks.py:add_changesets 169 170 [trac] 171 env = /path/to/env 172 trac-admin = /path/to/trac-admin 173 }}} 130 174 131 175 === Per-request synchronization === #PerRequestSync … … 139 183 140 184 1. Remove the default repository specification from the `[trac] repository_dir` option. 141 1. Add the "main"repository as a named repository.185 1. Add the main repository as a named repository. 142 186 1. Re-synchronize the main repository. 143 1. Set up post-commit and post-revprop-change hooks on the mainrepository, and set `[trac] repository_sync_per_request` to an empty value.144 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.145 1. Repeat steps 2, 3 and 4 to add other (named)repositories as needed.187 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. 188 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. 189 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed. 146 190 147 191 == Migration from a single-repository setup (Mercurial) == #MigrationMercurial 148 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 #9485for more information.192 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. 149 193 150 194 1. Upgrade to the latest version of the TracMercurial plugin. 151 195 1. Remove the default repository specification from the `[trac] repository_dir` option. 152 1. Add the "main"repository as a named repository.153 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.154 1. Repeat step 3 to add other (named)repositories as needed.196 1. Add the main repository as a named repository. 197 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. 198 1. Repeat step 3 to add other "named" repositories as needed. 155 199 156 200 == Troubleshooting ==