MCProxy

Changes between Version 1 and Version 2 of TracRepositoryAdmin


Ignore:
Timestamp:
02/19/15 12:54:28 (10 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracRepositoryAdmin

    v1 v2  
    1 = Repository Administration =
     1= Repository Administration
    22[[PageOutline(2-3)]]
    33
    4 == Quick start == #QuickStart
     4== Quick start #QuickStart
    55
    66 * Manage repositories in the "Repository" admin panel, with `trac-admin` or in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini].
    … …  
    99 * 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
    11 == Specifying repositories == #Repositories
     11== Specifying repositories #Repositories
    1212Starting 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.
    1313
    … …  
    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.
    … …  
    3635
    3736
    38 === In `trac.ini` === #ReposTracIni
     37=== In `trac.ini` #ReposTracIni
    3938Repositories 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.
    4039
    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.
    44 {{{
    45 #!ini
     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.
     43{{{#!ini
    4644[repositories]
    4745project.dir = /var/repos/project
    … …  
    4947project.type = svn
    5048project.url = http://example.com/svn/project
     49project.hidden = true
     50
    5151lib.dir = /var/repos/lib
    5252lib.description = This is the secondary library code.
    5353lib.type = svn
    5454lib.url = http://example.com/svn/lib
     55
    5556.alias = project
    56 .hidden = true
    5757}}}
    5858Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around.
    5959
    60 === In the database === #ReposDatabase
     60=== In the database #ReposDatabase
    6161Repositories can also be specified in the database, using either the "Repositories" admin panel under "Version Control", or the `trac-admin $ENV repository` commands.
    6262
    … …  
    8080
    8181
    82 == Repository synchronization == #Synchronization
     82== Repository synchronization #Synchronization
    8383Prior 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.
    8484
    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 ===
     87=== Mercurial Repositories
    8888Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:#9485] for more information.
    8989
    90 === Explicit synchronization === #ExplicitSync
    91 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.
     90=== Explicit synchronization #ExplicitSync
     91This 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.
    9292
    9393 `changeset added <repos> <rev> [...]`::
    … …  
    9999The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
    100100
    101 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.
     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
     103==== Subversion
    102104
    103105The 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`):
    … …  
    107109/usr/bin/trac-admin /path/to/env changeset added "$1" "$2"
    108110}}}
     111Note: Check with `whereis trac-admin`, whether `trac-admin` is really installed under `/usr/bin/` or maybe under `/usr/local/bin/` and adapt the path.
    109112On Windows (`post-commit.cmd`):
    110 {{{#!application/x-dos-batch
     113{{{#!bat
    111114@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2"
    112115}}}
    … …  
    119122}}}
    120123On Windows (`post-revprop-change.cmd`):
    121 {{{#!application/x-dos-batch
     124{{{#!bat
    122125@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2"
    123126}}}
    … …  
    127130Note 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.
    128131
    129 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.
    130 
    131 === Per-request synchronization === #PerRequestSync
     132See 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.
     133
     134==== Git
     135
     136Git 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):
     137{{{#!sh
     138#!/bin/sh
     139REV=$(git rev-parse HEAD)
     140trac-admin /path/to/env changeset added <repos> $REV
     141}}}
     142
     143Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo:
     144{{{#!sh
     145#!/bin/sh
     146while read oldrev newrev refname; do
     147        git rev-list --reverse $newrev ^$oldrev  | \
     148        while read rev; do
     149                trac-admin /path/to/env changeset added <repos> $rev
     150        done
     151done
     152}}}
     153
     154The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
     155
     156==== Mercurial
     157
     158For 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):
     159{{{#!ini
     160[hooks]
     161; If mercurial-plugin is installed globally
     162commit = python:tracext.hg.hooks.add_changesets
     163changegroup = python:tracext.hg.hooks.add_changesets
     164
     165; If mercurial-plugin is installed in a Trac plugins directory
     166commit = python:/path/to/hooks.py:add_changesets
     167changegroup = python:/path/to/hooks.py:add_changesets
     168
     169[trac]
     170env = /path/to/env
     171trac-admin = /path/to/trac-admin
     172}}}
     173
     174=== Per-request synchronization #PerRequestSync
    132175If 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.
    133176
    … …  
    135178
    136179
    137 == Migration from a single-repository setup (Subversion) == #Migration
     180== Migration from a single-repository setup (Subversion) #Migration
    138181The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories.
    139182
    140183 1. Remove the default repository specification from the `[trac] repository_dir` option.
    141  1. Add the "main" repository as a named repository.
     184 1. Add the main repository as a named repository.
    142185 1. Re-synchronize the main repository.
    143  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.
    144  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.
    145  1. Repeat steps 2, 3 and 4 to add other (named) repositories as needed.
    146 
    147 == Migration from a single-repository setup (Mercurial) == #MigrationMercurial
    148 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.
     186 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.
     187 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.
     188 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed.
     189
     190== Migration from a single-repository setup (Mercurial) #MigrationMercurial
     191The 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.
    149192
    150193 1. Upgrade to the latest version of the TracMercurial plugin.
    151194 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 
    156 == Troubleshooting ==
    157 
    158 === My trac-post-commit-hook doesn't work anymore === #trac-post-commit-hook
     195 1. Add the main repository as a named repository.
     196 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.
     197 1. Repeat step 3 to add other "named" repositories as needed.
     198
     199== Troubleshooting
     200
     201=== My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook
    159202
    160203You 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.