Changes between Version 2 and Version 3 of TracRepositoryAdmin
- Timestamp:
- May 4, 2020, 5:16:30 PM (5 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 == #QuickStart 5 6 * Manage repositories in the "Repository" admin panel, with `trac-admin` or in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini]. 4 == Quick start #QuickStart 5 6 * Enable the repository connector(s) for the version control system(s) that you will use. 7 * Add repositories through the //Repositories// admin panel, with `trac-admin` or in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini]. 7 8 * 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 * Set the `[trac] repository_sync_per_request` option to an empty value to disable per-request syncing. 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 11 == Specifying repositories == #Repositories 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 14 It is also possible to define aliases of repositories, that act as "pointers" to real repositories. This can be useful when renaming a repository, to avoid breaking all the links to the old name. 15 16 A number of attributes can be associated with each repository, which define the repository's location, type, name and how it is displayed in the source browser. The following attributes are supported: 9 * Make sure the user under which your hooks are run has write access to the Trac environment, or use a tool like `sudo` to temporarily elevate privileges. 10 11 == Enabling the components 12 13 Support for version control systems is provided by optional components distributed with Trac, which are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them. 14 15 The version control systems can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the //Plugins// admin panel. 16 17 {{{#!ini 18 tracopt.versioncontrol.svn.* = enabled 19 }}} 20 21 {{{#!ini 22 tracopt.versioncontrol.git.* = enabled 23 }}} 24 25 == Specifying repositories #Repositories 26 Trac supports multiple repositories per environment, and the repositories may be for different version control system types. Each repository must be defined in a repository configuration provider, the two supported by default are the [#ReposDatabase database store] and the [#ReposTracIni trac.ini configuration file]. A repository should not be defined in multiple configuration providers. 27 28 It is possible to define aliases of repositories, that act as "pointers" to real repositories. This can be useful when renaming a repository, to avoid breaking links to the old name. 29 30 A number of attributes can be associated with each repository. The attributes define the repository's location, type, name and how it is displayed in the source browser. The following attributes are supported: 17 31 18 32 ||='''Attribute''' =||='''Description''' =|| … … 24 38 ||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 39 ||`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. || 40 ||`sync_per_request`||When set to `true` the repository will be synced on every request. This is not recommended, instead a post-commit hook should be configured to provide [#ExplicitSync explicit synchronization] and `sync_per_request` should be set to `false`.|| 26 41 ||`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 42 ||`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 44 A repository `name` and one of `alias` or `dir` attributes are mandatory. All others are optional. 30 45 46 For some version control systems, it is possible to specify not only the path to the repository in the `dir` attribute, but also a ''scope'' within the repository. Trac will then only show information related to the files and changesets below that scope. The Subversion backend for Trac supports this. For other types, check the corresponding plugin's documentation. 47 31 48 After adding a repository, the cache for that repository must be re-synchronized once with the `trac-admin $ENV repository resync` command. 32 49 … … 35 52 36 53 37 === In `trac.ini` ===#ReposTracIni54 === In `trac.ini` #ReposTracIni 38 55 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 56 … … 41 58 42 59 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 60 {{{#!ini 45 61 [repositories] 46 62 project.dir = /var/repos/project … … 59 75 Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around. 60 76 61 === In the database ===#ReposDatabase77 === In the database #ReposDatabase 62 78 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 79 … … 80 96 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 97 82 83 == Repository synchronization == #Synchronization 98 == Repository caching 99 100 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. 101 102 Subversion repositories are cached unless the type is `direct-svnfs`. Git repositories are cached when `[git]` [wiki:TracIni#git-section cached_repository] is `true`. 103 104 == Repository synchronization #Synchronization 84 105 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 106 86 107 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 108 88 === Mercurial Repositories ===109 === Mercurial Repositories 89 110 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 111 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.112 === Explicit synchronization #ExplicitSync 113 This is the preferred method of repository synchronization. It requires setting the `sync_per_request` attribute to `false`, 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 114 94 115 `changeset added <repos> <rev> [...]`:: … … 100 121 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 101 122 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. 123 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. 124 125 ==== Subversion 103 126 104 127 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 131 /usr/bin/trac-admin /path/to/env changeset added "$1" "$2" 109 132 }}} 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 }}} 133 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 134 On Windows (`post-commit.cmd`): 117 {{{#! application/x-dos-batch135 {{{#!bat 118 136 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2" 119 137 }}} … … 126 144 }}} 127 145 On Windows (`post-revprop-change.cmd`): 128 {{{#! application/x-dos-batch146 {{{#!bat 129 147 @C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2" 130 148 }}} … … 136 154 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 155 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 }}} 156 ==== Git 157 158 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): 159 {{{#!sh 160 #!/bin/sh 161 REV=$(git rev-parse HEAD) 162 trac-admin /path/to/env changeset added <repos> $REV 163 }}} 164 165 Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo: 166 {{{#!sh 167 #!/bin/sh 168 tracenv=/path/to/env # change with your Trac environment's path 169 repos= # change with your repository's name 170 while read oldrev newrev refname; do 171 if [ "$oldrev" = 0000000000000000000000000000000000000000 ]; then 172 git rev-list --reverse "$newrev" -- 173 else 174 git rev-list --reverse "$newrev" "^$oldrev" -- 175 fi | xargs trac-admin "$tracenv" changeset added "$repos" 176 done 177 }}} 178 179 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 180 181 ==== Mercurial 143 182 144 183 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 197 }}} 159 198 160 === Per-request synchronization ===#PerRequestSync161 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.199 === Per-request synchronization #PerRequestSync 200 If the post-commit hooks are not available, the environment can be set up for per-request synchronization. In that case, the `sync_per_request` attribute for each repository in the database and in [wiki:TracIni#trac-section trac.ini] must be set to `false`. 162 201 163 202 Note that in this case, the changeset listener extension point is not called, and therefore plugins using it will not work correctly. 164 203 165 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. 168 169 1. Remove the default repository specification from the `[trac] repository_dir` option. 170 1. Add the main repository as a named repository. 171 1. Re-synchronize the main repository. 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. 184 185 == Troubleshooting == 186 187 === My trac-post-commit-hook doesn't work anymore === #trac-post-commit-hook 204 == Automatic changeset references in tickets 205 206 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: 207 * '''`Refs #123`''' - to reference this changeset in `#123` ticket 208 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' 209 210 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. 211 {{{#!ini 212 tracopt.ticket.commit_updater.* = enabled 213 }}} 214 For more information, see the documentation of the `CommitTicketUpdater` component in the //Plugins// admin panel and the [trac:CommitTicketUpdater] page. 215 216 == Troubleshooting 217 218 === My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook 188 219 189 220 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.
