Changes between Version 2 and Version 3 of TracRepositoryAdmin


Ignore:
Timestamp:
08/08/15 13:07:51 (2 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracRepositoryAdmin

    v2 v3  
    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 ||`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. || 
    2727||`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. || 
    2828 
     
    3535 
    3636 
    37 === In `trac.ini` === #ReposTracIni 
     37=== In `trac.ini` #ReposTracIni 
    3838Repositories 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. 
    3939 
     
    4141 
    4242The 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 
     43{{{#!ini 
    4544[repositories] 
    4645project.dir = /var/repos/project 
     
    5958Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around. 
    6059 
    61 === In the database === #ReposDatabase 
     60=== In the database #ReposDatabase 
    6261Repositories can also be specified in the database, using either the "Repositories" admin panel under "Version Control", or the `trac-admin $ENV repository` commands. 
    6362 
     
    8079Note 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. 
    8180 
    82  
    83 == Repository synchronization == #Synchronization 
     81== Repository caching 
     82 
     83The 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. 
     84 
     85Subversion repositories are cached unless the type is `direct-svnfs`. Git repositories are cached when `[git]` [wiki:TracIni#git-section cached_repository] is `true`. 
     86 
     87== Repository synchronization #Synchronization 
    8488Prior 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.  
    8589 
    8690There 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. 
    8791 
    88 === Mercurial Repositories === 
     92=== Mercurial Repositories 
    8993Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:#9485] for more information.  
    9094 
    91 === Explicit synchronization === #ExplicitSync 
    92 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. 
     95=== Explicit synchronization #ExplicitSync 
     96This 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. 
    9397 
    9498 `changeset added <repos> <rev> [...]`:: 
     
    100104The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 
    101105 
    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. 
     106Note 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. 
     107 
     108==== Subversion 
    103109 
    104110The 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`): 
     
    108114/usr/bin/trac-admin /path/to/env changeset added "$1" "$2" 
    109115}}} 
    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 }}} 
     116Note: Check with `whereis trac-admin`, whether `trac-admin` is really installed under `/usr/bin/` or maybe under `/usr/local/bin/` and adapt the path. 
    116117On Windows (`post-commit.cmd`): 
    117 {{{#!application/x-dos-batch 
     118{{{#!bat 
    118119@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2" 
    119120}}} 
     
    126127}}} 
    127128On Windows (`post-revprop-change.cmd`): 
    128 {{{#!application/x-dos-batch 
     129{{{#!bat 
    129130@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2" 
    130131}}} 
     
    136137See 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. 
    137138 
    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 }}} 
     139==== Git 
     140 
     141Git 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): 
     142{{{#!sh 
     143#!/bin/sh  
     144REV=$(git rev-parse HEAD)  
     145trac-admin /path/to/env changeset added <repos> $REV  
     146}}} 
     147 
     148Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo: 
     149{{{#!sh 
     150#!/bin/sh 
     151tracenv=/path/to/env     # change with your Trac environment's path 
     152repos=                   # change with your repository's name 
     153while read oldrev newrev refname; do 
     154    if [ "$oldrev" = 0000000000000000000000000000000000000000 ]; then 
     155        git rev-list --reverse "$newrev" -- 
     156    else 
     157        git rev-list --reverse "$newrev" "^$oldrev" -- 
     158    fi | xargs trac-admin "$tracenv" changeset added "$repos" 
     159done 
     160}}} 
     161 
     162The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository. 
     163 
     164==== Mercurial 
    143165 
    144166For 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): 
     
    158180}}} 
    159181 
    160 === Per-request synchronization === #PerRequestSync 
     182=== Per-request synchronization #PerRequestSync 
    161183If 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. 
    162184 
     
    164186 
    165187 
    166 == Migration from a single-repository setup (Subversion) == #Migration 
     188== Automatic changeset references in tickets 
     189 
     190You 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: 
     191 * '''`Refs #123`''' - to reference this changeset in `#123` ticket 
     192 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed'' 
     193 
     194This 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. 
     195{{{#!ini 
     196tracopt.ticket.commit_updater.* = enabled 
     197}}} 
     198For more information, see the documentation of the `CommitTicketUpdater` component in the //Plugins// admin panel and the [trac:CommitTicketUpdater] page. 
     199 
     200== Migration from a single-repository setup (Subversion) #Migration 
    167201The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories. 
    168202 
     
    174208 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed. 
    175209 
    176 == Migration from a single-repository setup (Mercurial) == #MigrationMercurial 
     210== Migration from a single-repository setup (Mercurial) #MigrationMercurial 
    177211The 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. 
    178212 
    179  1. Upgrade to the latest version of the TracMercurial plugin. 
     213 1. Upgrade to the latest version of the [trac:TracMercurial] plugin. 
    180214 1. Remove the default repository specification from the `[trac] repository_dir` option. 
    181215 1. Add the main repository as a named repository. 
     
    183217 1. Repeat step 3 to add other "named" repositories as needed. 
    184218 
    185 == Troubleshooting == 
    186  
    187 === My trac-post-commit-hook doesn't work anymore === #trac-post-commit-hook 
     219== Troubleshooting 
     220 
     221=== My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook 
    188222 
    189223You 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.