Changes between Version 1 and Version 2 of TracRepositoryAdmin


Ignore:
Timestamp:
Nov 18, 2014 10:44:13 PM (5 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
     
    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. ||
    27 ||`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. ||
    2827||`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. ||
    2928
    30 The `name` attribute and one of `alias` or `dir` are mandatory. All others are optional.
     29A repository `name` and one of `alias` or `dir` attributes are mandatory. All others are optional.
    3130
    3231After adding a repository, the cache for that repository must be re-synchronized once with the `trac-admin $ENV repository resync` command.
     
    4140The 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.
    4241
    43 The 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.
     42The 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.
    4443{{{
    4544#!ini
     
    4948project.type = svn
    5049project.url = http://example.com/svn/project
     50project.hidden = true
     51
    5152lib.dir = /var/repos/lib
    5253lib.description = This is the secondary library code.
    5354lib.type = svn
    5455lib.url = http://example.com/svn/lib
     56
    5557.alias = project
    56 .hidden = true
    5758}}}
    5859Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around.
     
    8586There 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.
    8687
     88=== Mercurial Repositories ===
     89Please 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
    8791=== Explicit synchronization === #ExplicitSync
    88 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.
     92This 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.
    8993
    9094 `changeset added <repos> <rev> [...]`::
     
    96100The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
    97101
     102Note 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
     104==== Subversion ====
     105
    98106The 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
     107{{{#!sh
    101108#!/bin/sh
     109export PYTHON_EGG_CACHE="/path/to/dir"
    102110/usr/bin/trac-admin /path/to/env changeset added "$1" "$2"
    103111}}}
     112Note: Check with `whereis trac-admin`, whether `trac-admin` is really installed under `/usr/bin/` or maybe under `/usr/local/bin/` and adapt the path.
    104113On Windows (`post-commit.cmd`):
    105 {{{
    106 #!application/x-dos-batch
     114{{{#!bat
    107115@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2"
    108116}}}
    109117
    110118The post-revprop-change hook for Subversion is very similar. On Unix (`post-revprop-change`):
    111 {{{
    112 #!sh
     119{{{#!sh
    113120#!/bin/sh
     121export PYTHON_EGG_CACHE="/path/to/dir"
    114122/usr/bin/trac-admin /path/to/env changeset modified "$1" "$2"
    115123}}}
    116124On Windows (`post-revprop-change.cmd`):
    117 {{{
    118 #!application/x-dos-batch
     125{{{#!bat
    119126@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2"
    120127}}}
    121128
     129The 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`.
     130
    122131Note 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.
    123132
    124 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. Please see the plugin documentation for specific instructions.
     133See 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.
     134
     135==== Git ====
     136
     137Git 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-receive` file in your git repo (note: this will do nothing if you only update the repo by pushing to it):
     138{{{#!sh
     139#!/bin/sh
     140REV=$(git rev-parse HEAD)
     141trac-admin /path/to/env changeset added <repos> $REV
     142}}}
     143
     144Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo:
     145{{{#!sh
     146#!/bin/sh
     147while read oldrev newrev refname; do
     148        git rev-list --reverse $newrev ^$oldrev  | \
     149        while read rev; do
     150                trac-admin /path/to/env changeset added <repos> $rev
     151        done
     152done
     153}}}
     154
     155The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
     156
     157==== Mercurial ====
     158
     159For 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):
     160{{{#!ini
     161[hooks]
     162; If mercurial-plugin is installed globally
     163commit = python:tracext.hg.hooks.add_changesets
     164changegroup = python:tracext.hg.hooks.add_changesets
     165
     166; If mercurial-plugin is installed in a Trac plugins directory
     167commit = python:/path/to/hooks.py:add_changesets
     168changegroup = python:/path/to/hooks.py:add_changesets
     169
     170[trac]
     171env = /path/to/env
     172trac-admin = /path/to/trac-admin
     173}}}
    125174
    126175=== Per-request synchronization === #PerRequestSync
     
    130179
    131180
    132 == Migration from a single-repository setup == #Migration
    133 The following procedure illustrates a typical migration from a single-repository setup to multiple repositories.
     181== Migration from a single-repository setup (Subversion) == #Migration
     182The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories.
    134183
    135184 1. Remove the default repository specification from the `[trac] repository_dir` option.
    136  1. Add the "main" repository as a named repository.
     185 1. Add the main repository as a named repository.
    137186 1. Re-synchronize the main repository.
    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.
     187 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.
     188 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.
     189 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed.
     190
     191== Migration from a single-repository setup (Mercurial) == #MigrationMercurial
     192The 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.
     193
     194 1. Upgrade to the latest version of the TracMercurial plugin.
     195 1. Remove the default repository specification from the `[trac] repository_dir` option.
     196 1. Add the main repository as a named repository.
     197 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.
     198 1. Repeat step 3 to add other "named" repositories as needed.
    141199
    142200== Troubleshooting ==