Changes between Version 1 and Version 2 of TracRepositoryAdmin


Ignore:
Timestamp:
Aug 31, 2019, 12:18:56 PM (5 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
    5 
    6  * Manage repositories in the "Repository" admin panel, with `trac-admin` or in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini].
     4== Quick start #QuickStart
     5
     6 * Enable the repository connector(s) for the version control system(s) that you will use.
     7 * Add repositories through the //Repositories// admin panel, with `trac-admin` or in the `[repositories]` section of [wiki:TracIni#repositories-section trac.ini].
    78 * 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.
    8  * Set the `[trac] repository_sync_per_request` option to an empty value to disable per-request syncing.
    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.
    10 
    11 == Specifying repositories == #Repositories
    12 Starting 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.
    13 
    14 It is also possible to define aliases of repositories, that act as "pointers" to real repositories. This can be useful when renaming a repository, to avoid breaking all the links to the old name.
    15 
    16 A number of attributes can be associated with each repository, which define the repository's location, type, name and how it is displayed in the source browser. The following attributes are supported:
     9 * Make sure the user under which your hooks are run has write access to the Trac environment, or use a tool like `sudo` to temporarily elevate privileges.
     10
     11== Enabling the components
     12
     13Support for version control systems is provided by optional components distributed with Trac, which are disabled by default //(since 1.0)//. Subversion and Git must be explicitly enabled if you wish to use them.
     14
     15The version control systems can be enabled by adding the following to the `[components]` section of your [TracIni#components-section trac.ini], or enabling the components in the //Plugins// admin panel.
     16
     17{{{#!ini
     18tracopt.versioncontrol.svn.* = enabled
     19}}}
     20
     21{{{#!ini
     22tracopt.versioncontrol.git.* = enabled
     23}}}
     24
     25== Specifying repositories #Repositories
     26Trac supports multiple repositories per environment, and the repositories may be for different version control system types. Each repository must be defined in a repository configuration provider, the two supported by default are the [#ReposDatabase database store] and the [#ReposTracIni trac.ini configuration file]. A repository should not be defined in multiple configuration providers.
     27
     28It is possible to define aliases of repositories, that act as "pointers" to real repositories. This can be useful when renaming a repository, to avoid breaking links to the old name.
     29
     30A number of attributes can be associated with each repository. The attributes define the repository's location, type, name and how it is displayed in the source browser. The following attributes are supported:
    1731
    1832||='''Attribute''' =||='''Description''' =||
    19 ||`alias` ||\\
     33||`alias` ||\
    2034||A repository having an `alias` attribute is an alias to a real repository. All TracLinks referencing the alias resolve to the aliased repository. Note that multiple indirection is not supported, so an alias must always point to a real repository. The `alias` and `dir` attributes are mutually exclusive. ||
    21 ||`description` ||\\
     35||`description` ||\
    2236||The text specified in the `description` attribute is displayed below the top-level entry for the repository in the source browser. It supports WikiFormatting. ||
    23 ||`dir` ||\\
     37||`dir` ||\
    2438||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. ||
    2539||`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. ||
     40||`sync_per_request`||When set to `true` the repository will be synced on every request. This is not recommended, instead a post-commit hook should be configured to provide [#ExplicitSync explicit synchronization] and `sync_per_request` should be set to `false`.||
     41||`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 `[versioncontrol] default_repository_type` option. ||
    2742||`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. ||
    2843
    2944A repository `name` and one of `alias` or `dir` attributes are mandatory. All others are optional.
     45
     46For some version control systems, it is possible to specify not only the path to the repository in the `dir` attribute, but also a ''scope'' within the repository. Trac will then only show information related to the files and changesets below that scope. The Subversion backend for Trac supports this. For other types, check the corresponding plugin's documentation.
    3047
    3148After adding a repository, the cache for that repository must be re-synchronized once with the `trac-admin $ENV repository resync` command.
     
    3552
    3653
    37 === In `trac.ini` === #ReposTracIni
     54=== In `trac.ini` #ReposTracIni
    3855Repositories 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.
    3956
     
    4158
    4259The 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
     60{{{#!ini
    4561[repositories]
    4662project.dir = /var/repos/project
     
    5975Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around.
    6076
    61 === In the database === #ReposDatabase
     77=== In the database #ReposDatabase
    6278Repositories can also be specified in the database, using either the "Repositories" admin panel under "Version Control", or the `trac-admin $ENV repository` commands.
    6379
     
    8096Note 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.
    8197
    82 
    83 == Repository synchronization == #Synchronization
     98== Repository caching
     99
     100The 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.
     101
     102Subversion repositories are cached unless the type is `direct-svnfs`. Git repositories are cached when `[git]` [wiki:TracIni#git-section cached_repository] is `true`.
     103
     104== Repository synchronization #Synchronization
    84105Prior 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.
    85106
    86107There 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.
    87108
    88 === Mercurial Repositories ===
     109=== Mercurial Repositories
    89110Please note that at the time of writing, no initial resynchronization or any hooks are necessary for Mercurial repositories - see [trac:#9485] for more information.
    90111
    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.
     112=== Explicit synchronization #ExplicitSync
     113This is the preferred method of repository synchronization. It requires setting the `sync_per_request` attribute to `false`, 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.
    93114
    94115 `changeset added <repos> <rev> [...]`::
     
    100121The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
    101122
    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.
     123Note 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.
     124
     125==== Subversion
     126
     127===== Using `trac-svn-hook`
     128
     129In a Unix environment, the simplest way to configure explicit synchronization is by using the [trac:source:branches/1.2-stable/contrib/trac-svn-hook contrib/trac-svn-hook] script. `trac-svn-hook` starts `trac-admin` asynchronously to avoid slowing the commit and log editing operations. The script comes with a number of safety checks and usage advice. Output is written to a log file with prefix `svn-hooks-` in the environment `log` directory, which can make configuration issues easier to debug.
     130
     131There's no equivalent `trac-svn-hook.bat` for Windows yet, but the script can be run by Cygwin's bash.
     132
     133Follow the help in the documentation header of the script to configure `trac-svn-hook`. Configuring the hook environment variables is made easier in Subversion 1.8 by using the [http://svnbook.red-bean.com/en/1.8/svn.reposadmin.create.html#svn.reposadmin.hooks.configuration hook script environment] configuration. Rather than directly editing `trac-svn-hook` to set the environment variables, they can be configured through the repository `conf/hooks-env` file. Replace the [trac:source:branches/1.2-stable/contrib/trac-svn-hook@:65-67#L61 configuration section] with:
     134{{{#!sh
     135export PATH=$PYTHON_BIN:$PATH
     136export LD_LIBRARY_PATH=$PYTHON_LIB:$LD_LIBRARY_PATH
     137}}}
     138and set the variables `TRAC_ENV`, `PYTHON_BIN` and `PYTHON_LIB` in the `hooks-env` file. Here is an example, using a Python virtual environment at `/usr/local/venv`:
     139{{{#!ini
     140[default]
     141TRAC_ENV=/var/trac/project-1
     142PYTHON_BIN=/usr/local/venv/bin
     143PYTHON_LIB=/usr/local/venv/lib
     144}}}
     145
     146===== Writing Your Own Hook Script
    103147
    104148The 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`):
     
    108152/usr/bin/trac-admin /path/to/env changeset added "$1" "$2"
    109153}}}
    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 }}}
     154Note: Check with `whereis trac-admin`, whether `trac-admin` is really installed under `/usr/bin/` or maybe under `/usr/local/bin/` and adapt the path.
    116155On Windows (`post-commit.cmd`):
    117 {{{#!application/x-dos-batch
    118 @C:\\Python26\\Scripts\\trac-admin.exe C:\\path\\to\\env changeset added "%1" "%2"
     156{{{#!bat
     157@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2"
    119158}}}
    120159
     
    126165}}}
    127166On Windows (`post-revprop-change.cmd`):
    128 {{{#!application/x-dos-batch
    129 @C:\\Python26\\Scripts\\trac-admin.exe C:\\path\\to\\env changeset modified "%1" "%2"
     167{{{#!bat
     168@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2"
    130169}}}
    131170
    132171The 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`.
    133172
    134 Note 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.
    135 
    136 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.
    137 
    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 }}}
     173See the [http://svnbook.red-bean.com/en/1.7/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.
     174
     175==== Git
     176
     177Git 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):
     178{{{#!sh
     179#!/bin/sh
     180REV=$(git rev-parse HEAD)
     181trac-admin /path/to/env changeset added <repos> $REV
     182}}}
     183
     184Alternately, if your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo:
     185{{{#!sh
     186#!/bin/sh
     187tracenv=/path/to/env     # change with your Trac environment's path
     188repos=                   # change with your repository's name
     189while read oldrev newrev refname; do
     190    if [ "$oldrev" = 0000000000000000000000000000000000000000 ]; then
     191        git rev-list --reverse "$newrev" --
     192    else
     193        git rev-list --reverse "$newrev" "^$oldrev" --
     194    fi | xargs trac-admin "$tracenv" changeset added "$repos"
     195done
     196}}}
     197
     198The `<repos>` argument can be either a repository name (use "`(default)`" for the default repository) or the path to the repository.
     199
     200==== Mercurial
    143201
    144202For 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):
     
    158216}}}
    159217
    160 === Per-request synchronization === #PerRequestSync
    161 If 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.
     218=== Per-request synchronization #PerRequestSync
     219If the post-commit hooks are not available, the environment can be set up for per-request synchronization. In that case, the `sync_per_request` attribute for each repository in the database and in [wiki:TracIni#trac-section trac.ini] must be set to `false`.
    162220
    163221Note that in this case, the changeset listener extension point is not called, and therefore plugins using it will not work correctly.
    164222
    165 
    166 == Migration from a single-repository setup (Subversion) == #Migration
    167 The following procedure illustrates a typical migration from a Subversion single-repository setup to multiple repositories.
    168 
    169  1. Remove the default repository specification from the `[trac] repository_dir` option.
    170  1. Add the main repository as a named repository.
    171  1. Re-synchronize the main repository.
    172  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.
    173  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.
    174  1. Repeat steps 2, 3 and 4 to add other "named" repositories as needed.
    175 
    176 == Migration from a single-repository setup (Mercurial) == #MigrationMercurial
    177 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 [trac:ticket:9485 #9485] for more information.
    178 
    179  1. Upgrade to the latest version of the TracMercurial plugin.
    180  1. Remove the default repository specification from the `[trac] repository_dir` option.
    181  1. Add the main repository as a named repository.
    182  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.
    183  1. Repeat step 3 to add other "named" repositories as needed.
    184 
    185 == Troubleshooting ==
    186 
    187 === My trac-post-commit-hook doesn't work anymore === #trac-post-commit-hook
     223== Automatic changeset references in tickets
     224
     225You 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:
     226 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     227 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     228
     229This 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.
     230{{{#!ini
     231tracopt.ticket.commit_updater.* = enabled
     232}}}
     233For more information, see the documentation of the `CommitTicketUpdater` component in the //Plugins// admin panel and the [trac:CommitTicketUpdater] page.
     234
     235== Troubleshooting
     236
     237=== My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook
    188238
    189239You 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.
     240
     241See [trac:CommitTicketUpdater#Troubleshooting] for more troubleshooting tips.