Changes between Version 1 and Version 2 of TracRepositoryAdmin


Ignore:
Timestamp:
Mar 17, 2011, 2:15:45 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracRepositoryAdmin

    v1 v2  
    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 
     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.
    1010
    1111== Specifying repositories == #Repositories
    … …  
    8585There 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.
    8686
     87=== Mercurial Repositories ===
     88Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:#9485] for more information.
     89
    8790=== Explicit synchronization === #ExplicitSync
    8891This 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.
    … …  
    9699The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
    97100
     101Note 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
    98103The 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`):
    99 {{{
    100 #!sh
     104{{{#!sh
    101105#!/bin/sh
     106export PYTHON_EGG_CACHE="/path/to/dir"
    102107/usr/bin/trac-admin /path/to/env changeset added "$1" "$2"
    103108}}}
    104109On Windows (`post-commit.cmd`):
    105 {{{
    106 #!application/x-dos-batch
     110{{{#!application/x-dos-batch
    107111@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2"
    108112}}}
    109113
    110114The post-revprop-change hook for Subversion is very similar. On Unix (`post-revprop-change`):
    111 {{{
    112 #!sh
     115{{{#!sh
    113116#!/bin/sh
     117export PYTHON_EGG_CACHE="/path/to/dir"
    114118/usr/bin/trac-admin /path/to/env changeset modified "$1" "$2"
    115119}}}
    116120On Windows (`post-revprop-change.cmd`):
    117 {{{
    118 #!application/x-dos-batch
     121{{{#!application/x-dos-batch
    119122@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2"
    120123}}}
     124
     125The 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`.
    121126
    122127Note 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.
    … …  
    130135
    131136
    132 == Migration from a single-repository setup == #Migration
    133 The following procedure illustrates a typical migration from a single-repository setup to multiple repositories.
     137== Migration from a single-repository setup (Subversion) == #Migration
     138The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories.
    134139
    135140 1. Remove the default repository specification from the `[trac] repository_dir` option.
    … …  
    140145 1. Repeat steps 2, 3 and 4 to add other (named) repositories as needed.
    141146
     147== Migration from a single-repository setup (Mercurial) == #MigrationMercurial
     148The 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.
     149
     150 1. Upgrade to the latest version of the TracMercurial plugin.
     151 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.
     155
    142156== Troubleshooting ==
    143157