Changes between Version 3 and Version 4 of TracRepositoryAdmin
- Timestamp:
- 07/03/17 09:52:10 (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracRepositoryAdmin
v3 v4 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]. … … 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 == Specifying repositories ==#Repositories11 == 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 … … 35 35 36 36 37 === In `trac.ini` ===#ReposTracIni37 === In `trac.ini` #ReposTracIni 38 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. 39 39 … … 41 41 42 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 {{{ 44 #!ini 43 {{{#!ini 45 44 [repositories] 46 45 project.dir = /var/repos/project … … 59 58 Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around. 60 59 61 === In the database ===#ReposDatabase60 === In the database #ReposDatabase 62 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. 63 62 … … 81 80 82 81 83 == Repository synchronization ==#Synchronization82 == Repository synchronization #Synchronization 84 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. 85 84 86 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. 87 86 88 === Mercurial Repositories ===87 === Mercurial Repositories 89 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. 90 89 91 === Explicit synchronization ===#ExplicitSync92 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.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. 93 92 94 93 `changeset added <repos> <rev> [...]`:: … … 100 99 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 101 100 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. 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 103 104 104 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`): … … 108 109 /usr/bin/trac-admin /path/to/env changeset added "$1" "$2" 109 110 }}} 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 }}} 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. 116 112 On Windows (`post-commit.cmd`): 117 {{{#! application/x-dos-batch113 {{{#!bat 118 114 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2" 119 115 }}} … … 126 122 }}} 127 123 On Windows (`post-revprop-change.cmd`): 128 {{{#! application/x-dos-batch124 {{{#!bat 129 125 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2" 130 126 }}} … … 136 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. 137 133 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 }}} 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 143 157 144 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): … … 158 172 }}} 159 173 160 === Per-request synchronization ===#PerRequestSync174 === Per-request synchronization #PerRequestSync 161 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. 162 176 … … 164 178 165 179 166 == Migration from a single-repository setup (Subversion) == #Migration 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 167 193 The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories. 168 194 … … 174 200 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed. 175 201 176 == Migration from a single-repository setup (Mercurial) ==#MigrationMercurial202 == Migration from a single-repository setup (Mercurial) #MigrationMercurial 177 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. 178 204 179 1. Upgrade to the latest version of the TracMercurialplugin.205 1. Upgrade to the latest version of the [trac:TracMercurial] plugin. 180 206 1. Remove the default repository specification from the `[trac] repository_dir` option. 181 207 1. Add the main repository as a named repository. … … 183 209 1. Repeat step 3 to add other "named" repositories as needed. 184 210 185 == Troubleshooting ==186 187 === My trac-post-commit-hook doesn't work anymore ===#trac-post-commit-hook211 == Troubleshooting 212 213 === My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook 188 214 189 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.
