Changes between Version 1 and Version 2 of TracRepositoryAdmin
- Timestamp:
- Oct 21, 2016, 7:54:42 PM (7 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracRepositoryAdmin
v1 v2 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 … … 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 ||`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. || 27 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 28 … … 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 … … 80 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. 81 80 82 83 == Repository synchronization == #Synchronization 81 == Repository caching 82 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`. 86 87 == Repository synchronization #Synchronization 84 88 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 89 86 90 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 91 88 === Mercurial Repositories ===92 === Mercurial Repositories 89 93 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 94 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.95 === Explicit synchronization #ExplicitSync 96 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 97 94 98 `changeset added <repos> <rev> [...]`:: … … 100 104 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 101 105 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. 106 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. 107 108 ==== Subversion 103 109 104 110 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 114 /usr/bin/trac-admin /path/to/env changeset added "$1" "$2" 109 115 }}} 116 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. 110 117 On Windows (`post-commit.cmd`): 111 {{{#! application/x-dos-batch118 {{{#!bat 112 119 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2" 113 120 }}} … … 120 127 }}} 121 128 On Windows (`post-revprop-change.cmd`): 122 {{{#! application/x-dos-batch129 {{{#!bat 123 130 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2" 124 131 }}} … … 130 137 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. 131 138 132 Git hooks can be used in the same way for explicit syncing of git repositories. Add the following to `.git/hooks/post-commit`: 133 {{{#!sh 134 REV=$(git rev-parse HEAD) 135 trac-admin /path/to/env changeset added <my-repository> $REV 136 }}} 137 138 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 [source:plugins/0.13/mercurial-plugin/tracext/hg/hooks.py hooks.py] and place it somewhere accessible): 139 ==== Git 140 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 153 while read oldrev newrev refname; do 154 if [ "$oldrev" = 0000000000000000000000000000000000000000 ]; then 155 git rev-list --reverse "$newrev" -- 156 else 157 git rev-list --reverse "$newrev" "^$oldrev" -- 158 fi | xargs trac-admin "$tracenv" changeset added "$repos" 159 done 160 }}} 161 162 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 163 164 ==== Mercurial 165 166 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): 139 167 {{{#!ini 140 168 [hooks] … … 152 180 }}} 153 181 154 === Per-request synchronization ===#PerRequestSync182 === Per-request synchronization #PerRequestSync 155 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. 156 184 … … 158 186 159 187 160 == Migration from a single-repository setup (Subversion) == #Migration 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: 191 * '''`Refs #123`''' - to reference this changeset in `#123` ticket 192 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' 193 194 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. 195 {{{#!ini 196 tracopt.ticket.commit_updater.* = enabled 197 }}} 198 For more information, see the documentation of the `CommitTicketUpdater` component in the //Plugins// admin panel and the [trac:CommitTicketUpdater] page. 199 200 == Migration from a single-repository setup (Subversion) #Migration 161 201 The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories. 162 202 … … 168 208 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed. 169 209 170 == Migration from a single-repository setup (Mercurial) ==#MigrationMercurial171 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.172 173 1. Upgrade to the latest version of the TracMercurialplugin.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. 174 214 1. Remove the default repository specification from the `[trac] repository_dir` option. 175 215 1. Add the main repository as a named repository. … … 177 217 1. Repeat step 3 to add other "named" repositories as needed. 178 218 179 == Troubleshooting ==180 181 === My trac-post-commit-hook doesn't work anymore ===#trac-post-commit-hook219 == Troubleshooting 220 221 === My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook 182 222 183 223 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.