Changes between Version 5 and Version 6 of TracRepositoryAdmin


Ignore:
Timestamp:
03/24/15 23:15:03 (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracRepositoryAdmin

    v5 v6  
    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 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. ||
     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. ||
    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 {{{#!ini
     43{{{
     44#!ini
    4445[repositories]
    4546project.dir = /var/repos/project
     
    5859Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around.
    5960
    60 === In the database #ReposDatabase
     61=== In the database === #ReposDatabase
    6162Repositories can also be specified in the database, using either the "Repositories" admin panel under "Version Control", or the `trac-admin $ENV repository` commands.
    6263
     
    8081
    8182
    82 == Repository synchronization #Synchronization
     83== Repository synchronization == #Synchronization
    8384Prior 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.
    8485
    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
    87 === Mercurial Repositories
     88=== Mercurial Repositories ===
    8889Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:#9485] for more information.
    8990
    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.
     91=== Explicit synchronization === #ExplicitSync
     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.
    9293
    9394 `changeset added <repos> <rev> [...]`::
     
    99100The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
    100101
    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.
    102 
    103 ==== Subversion
     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.
    104103
    105104The 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`):
     
    109108/usr/bin/trac-admin /path/to/env changeset added "$1" "$2"
    110109}}}
    111 Note: Check with `whereis trac-admin`, whether `trac-admin` is really installed under `/usr/bin/` or maybe under `/usr/local/bin/` and adapt the path.
     110Note: Ubuntu doesn't seem to like /usr/bin/trac-admin, so just use:
     111{{{#!sh
     112#!/bin/sh
     113export PYTHON_EGG_CACHE="/path/to/dir"
     114trac-admin /path/to/env/ changeset added "$1" "$2"
     115}}}
    112116On Windows (`post-commit.cmd`):
    113 {{{#!bat
     117{{{#!application/x-dos-batch
    114118@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2"
    115119}}}
     
    122126}}}
    123127On Windows (`post-revprop-change.cmd`):
    124 {{{#!bat
     128{{{#!application/x-dos-batch
    125129@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2"
    126130}}}
     
    132136See 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.
    133137
    134 ==== Git
    135 
    136 Git 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):
     138Git hooks can be used in the same way for explicit syncing of git repositories. Add the following to `.git/hooks/post-commit`:
    137139{{{#!sh
    138 #!/bin/sh
    139 REV=$(git rev-parse HEAD)
    140 trac-admin /path/to/env changeset added <repos> $REV
     140REV=$(git rev-parse HEAD)
     141trac-admin /path/to/env changeset added <my-repository> $REV
    141142}}}
    142 
    143 Alternately, 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
    146 while 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
    151 done
    152 }}}
    153 
    154 The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
    155 
    156 ==== Mercurial
    157143
    158144For 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):
     
    172158}}}
    173159
    174 === Per-request synchronization #PerRequestSync
     160=== Per-request synchronization === #PerRequestSync
    175161If 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.
    176162
     
    178164
    179165
    180 == Migration from a single-repository setup (Subversion) #Migration
     166== Migration from a single-repository setup (Subversion) == #Migration
    181167The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories.
    182168
     
    188174 1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed.
    189175
    190 == Migration from a single-repository setup (Mercurial) #MigrationMercurial
     176== Migration from a single-repository setup (Mercurial) == #MigrationMercurial
    191177The 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.
    192178
    193  1. Upgrade to the latest version of the [trac:TracMercurial] plugin.
     179 1. Upgrade to the latest version of the TracMercurial plugin.
    194180 1. Remove the default repository specification from the `[trac] repository_dir` option.
    195181 1. Add the main repository as a named repository.
     
    197183 1. Repeat step 3 to add other "named" repositories as needed.
    198184
    199 == Troubleshooting
     185== Troubleshooting ==
    200186
    201 === My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook
     187=== My trac-post-commit-hook doesn't work anymore === #trac-post-commit-hook
    202188
    203189You 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.