Changes between Version 4 and Version 5 of TracRepositoryAdmin


Ignore:
Timestamp:
Dec 14, 2014, 5:16:20 PM (9 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracRepositoryAdmin

    v4 v5  
    77 * 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.
    88 * 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.
     9
    1010
    1111== Specifying repositories == #Repositories
    … …  
    2424||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. ||
    2525||`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. ||
    2627||`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. ||
    2728||`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. ||
    2829
    29 A repository `name` and one of `alias` or `dir` attributes are mandatory. All others are optional.
     30The `name` attribute and one of `alias` or `dir` are mandatory. All others are optional.
    3031
    3132After adding a repository, the cache for that repository must be re-synchronized once with the `trac-admin $ENV repository resync` command.
    … …  
    4041The 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.
    4142
    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.
     43The 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.
    4344{{{
    4445#!ini
    … …  
    4849project.type = svn
    4950project.url = http://example.com/svn/project
    50 project.hidden = true
    51 
    5251lib.dir = /var/repos/lib
    5352lib.description = This is the secondary library code.
    5453lib.type = svn
    5554lib.url = http://example.com/svn/lib
    56 
    5755.alias = project
     56.hidden = true
    5857}}}
    5958Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around.
    … …  
    8685There 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.
    8786
    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 
    9187=== Explicit synchronization === #ExplicitSync
    9288This 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.
    … …  
    10096The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
    10197
    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 
    10498The 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`):
    105 {{{#!sh
     99{{{
     100#!sh
    106101#!/bin/sh
    107 export PYTHON_EGG_CACHE="/path/to/dir"
    108102/usr/bin/trac-admin /path/to/env changeset added "$1" "$2"
    109103}}}
    110104On Windows (`post-commit.cmd`):
    111 {{{#!application/x-dos-batch
     105{{{
     106#!application/x-dos-batch
    112107@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2"
    113108}}}
    114109
    115110The post-revprop-change hook for Subversion is very similar. On Unix (`post-revprop-change`):
    116 {{{#!sh
     111{{{
     112#!sh
    117113#!/bin/sh
    118 export PYTHON_EGG_CACHE="/path/to/dir"
    119114/usr/bin/trac-admin /path/to/env changeset modified "$1" "$2"
    120115}}}
    121116On Windows (`post-revprop-change.cmd`):
    122 {{{#!application/x-dos-batch
     117{{{
     118#!application/x-dos-batch
    123119@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2"
    124120}}}
    125121
    126 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`.
    127 
    128122Note 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.
    129123
    130 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 
    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 {{{#!ini
    140 [hooks]
    141 ; If mercurial-plugin is installed globally
    142 commit = python:tracext.hg.hooks.add_changesets
    143 changegroup = python:tracext.hg.hooks.add_changesets
    144 
    145 ; If mercurial-plugin is installed in a Trac plugins directory
    146 commit = python:/path/to/hooks.py:add_changesets
    147 changegroup = python:/path/to/hooks.py:add_changesets
    148 
    149 [trac]
    150 env = /path/to/env
    151 trac-admin = /path/to/trac-admin
    152 }}}
     124See 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.
    153125
    154126=== Per-request synchronization === #PerRequestSync
    … …  
    158130
    159131
    160 == Migration from a single-repository setup (Subversion) == #Migration
    161 The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories.
     132== Migration from a single-repository setup == #Migration
     133The following procedure illustrates a typical migration from a single-repository setup to multiple repositories.
    162134
    163135 1. Remove the default repository specification from the `[trac] repository_dir` option.
    164  1. Add the main repository as a named repository.
     136 1. Add the "main" repository as a named repository.
    165137 1. Re-synchronize the main repository.
    166  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.
    167  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.
    168  1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed.
    169 
    170 == Migration from a single-repository setup (Mercurial) == #MigrationMercurial
    171 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 #9485 for more information.
    172 
    173  1. Upgrade to the latest version of the TracMercurial plugin.
    174  1. Remove the default repository specification from the `[trac] repository_dir` option.
    175  1. Add the main repository as a named repository.
    176  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.
    177  1. Repeat step 3 to add other "named" repositories as needed.
     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.
    178141
    179142== Troubleshooting ==