Changes between Initial Version and Version 1 of TracRepositoryAdmin

Jul 30, 2021, 7:40:25 AM (17 months ago)



  • TracRepositoryAdmin

    v1 v1  
     1= Repository Administration
     4== Quick start #QuickStart
     6 * Enable the repository connector(s) for the version control system(s) that you will use.
     7 * Add repositories through the //Repositories// admin page, using `trac-admin` or by editing the `[repositories]` section of [[wiki:TracIni#repositories-section|trac.ini]].
     8 * Synchronize the repositories with the cache, if using cached repositories.
     9 * Configure your repository hooks to synchronize the repository. Alternatively you can synchronize on every request or disable the use of cached repositories, both of which have performance drawbacks and reduced functionality, but are easier to configure.
     11== Enabling the components
     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.
     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 through the //Plugins// admin page.
     18tracopt.versioncontrol.svn.* = enabled
     22tracopt.versioncontrol.git.* = enabled
     25== Specifying repositories #Repositories
     27Trac supports multiple repositories per environment, and the repositories may be for different version control systems. Each repository must be defined in a repository configuration provider. Repository providers included with Trac are the [#ReposDatabase database store], the [#ReposTracIni trac.ini configuration file] and the [#ReposGitWeb GitWeb configuration file]. Additional providers are available as plugins.
     29You can define your repositories through a mix of providers, but each repository should only be defined in a single provider. The repository names must be unique across all providers and duplicate names are discarded.
     31It 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.
     33=== Default Repository
     35Trac's repositories are listed in the Repository Index when navigating to //Browse Source//. The default repository is displayed first, followed by the Repository Index. TracLinks without a repository name in the path specification (e.g. `[1]` rather than `[1/repos1]`) refer to the default repository. !TracLinks for repositories other than the default must include the repository name in the path specification.
     37From the Repository Admin page, the default repository is specified by leaving the //Name// attribute empty. From the command line, the default repository is specified using the string `(default)` or `""`. In TracIni, the default repository is specified by leaving the `{name}` empty for each `{name}.{attribute}` option (e.g. `.dir = /path/to/dir`).
     39=== Repository Attributes
     41There are a number of attributes that can be specified for each repository, and additional attributes may be available through plugins. A repository `name` and one of the `alias` or `dir` attributes are mandatory. All others are optional.
     43The following attributes are supported:
     45||='''Attribute''' =||='''Description''' =||
     46||`alias` ||\
     47||Defines 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. ||
     48|| `cached` ||\
     49|| For a version control system that support caching, specifies that repository caching should be used. Defaults to `true` for version control systems that support caching. ||
     50||`description` ||\
     51||The text specified in the `description` attribute is displayed below the top-level entry for the repository in the source browser. It supports WikiFormatting. ||
     52||`dir` ||\
     53||The `dir` attribute specifies the location of the repository in the filesystem. The `alias` and `dir` attributes are mutually exclusive. ||
     54||`hidden` ||\
     55|| 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. ||
     57|| When set to `true` the repository will be synchronized on every request (implicit synchronization). This is generally not recommended. See [#Synchronization repository synchronization] for a comparison of explicit and implicit synchronization. The attribute defaults to `false`. ||
     58||`type` ||\
     59|| The `type` attribute specifies the version control system used by the repository. Trac provides support for Subversion and Git, and plugins add support for several other systems. If `type` is not specified, it defaults to the value of the `[versioncontrol]` [wiki:TracIni#versioncontrol-default_repository_type-option default_repository_type] option. ||
     60||`url` ||\
     61|| 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. ||
     63=== Scoped Repository
     65For 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 scope is specified by appending a path that is relative to the repository root. The Subversion backend for Trac supports this.
     67For example, assume a repository at filesystem path `/var/svn/repos1` with several directories at the root of the repository: `/proj1`, `/proj2`, etc. The following configuration would scope the repository to `/proj1`:
     69proj1.dir = /var/svn/repos1/proj1
     70proj1.type = svn
     73For other repository types, check the corresponding plugin's documentation.
     75=== In the database #ReposDatabase
     76Repositories can also be specified in the database, using either the //Repositories// admin page under //Version Control//, or the `trac-admin $ENV repository` commands.
     78The admin panel shows the list of all repositories defined in the Trac environment. It allows adding repositories and aliases, editing repository attributes and removing repositories. Note that repositories defined in `trac.ini` are displayed but cannot be edited.
     80The following [wiki:TracAdmin trac-admin] commands can be used to perform repository operations from the command line.
     82 `repository add <repos> <dir> [type]`::
     83   Add a repository `<repos>` located at `<dir>`, and optionally specify its type.
     85 `repository alias <name> <target>`::
     86   Create an alias `<name>` for the repository `<target>`.
     88 `repository remove <repos>`::
     89   Remove the repository `<repos>`.
     91 `repository set <repos> <key> <value>`::
     92   Set the attribute `<key>` to `<value>` for the repository `<repos>`.
     94Note that the default repository has an empty name, so it will 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.
     96=== In `trac.ini` #ReposTracIni
     97Repositories 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.
     99The main advantage of specifying repositories in `trac.ini` is that they can be inherited from a [wiki:TracIni#GlobalConfiguration global configuration]. Cached repositories defined in `trac.ini` at the time of [TracEnvironment#SourceCodeRepository environment initialization] will be automatically synchronized if the repository's connector is enabled. One drawback is that due to limitations in the `ConfigParser` class used to parse `trac.ini`, the repository name is always lowercase.
     101The 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.
     104project.dir = /var/repos/project
     105project.description = This is the ''main'' project repository.
     106project.type = svn
     107project.url =
     108project.hidden = true
     110lib.dir = /var/repos/lib
     111lib.description = This is the secondary library code.
     112lib.type = svn
     113lib.url =
     115.alias = project
     117Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around.
     119=== In !GitWeb #ReposGitWeb
     121[ GitWeb] is a CGI script that comes with Git for web-based visualization of repositories. Trac can read the gitweb-formatted `project.lists` file. The configuration is done through the `[gitweb-repositories]` section of [[TracIni#gitweb-repositories-section|trac.ini]].
     123== Repository caching
     125Caching improves the performance browsing the repository, viewing logs and viewing changesets. Cached repositories must be [#Synchronization synchronized], using either explicit or implicit synchronization. When searching changesets, only cached repositories are searched.
     127Repositories that support caching are cached by default. The Subversion and Git backends support caching. The [trac:TracMercurial Mercurial plugin] does not yet support caching ([trac:#8417]). To disable caching, set the `cached` attribute to `false`.
     129After adding a cached repository, the cache must be populated with the `trac-admin $ENV repository resync` command.
     131 `repository resync <repos>`::
     132   Re-synchronize Trac with a repository.
     134== Repository synchronization #Synchronization
     136Either explicit or implicit synchronization can be used. Implicit synchronization is easier to configure, but may result in noticeably worse performance. The changeset added and modified events can't be triggered with implicit synchronization, so the [#Automaticchangesetreferencesintickets commit ticket updater] won't be available.
     138=== Explicit synchronization #ExplicitSync
     140This is the preferred method of repository synchronization. It requires 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.
     142 `changeset added <repos> <rev> [...]`::
     143   Notify Trac that one or more changesets have been added to a repository.
     145 `changeset modified <repos> <rev> [...]`::
     146   Notify Trac that metadata on one or more changesets in a repository has been modified.
     148The `<repos>` argument can be either a repository name (use `"(default)"` for the default repository) or the path to the repository.
     150Note 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#Settinguptheplugincache TracPlugins] for more information.
     152==== Subversion
     154===== Using `trac-svn-hook`
     156In a Unix environment, the simplest way to configure explicit synchronization is by using the [trac:source:branches/1.4-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.
     158There's no equivalent `trac-svn-hook.bat` for Windows yet, but the script can be run by Cygwin's bash. The documentation header of `trac-svn-hook` contains a Cygwin configuration example.
     160Follow the help in the documentation header of the script to configure `trac-svn-hook`. You'll need to minimally set the `TRAC_ENV` variable, and may also need to set `TRAC_PATH` and `TRAC_LD_LIBRARY_PATH` for a non-standard installation or a virtual environment.
     162Configuring the hook environment variables is even easier in Subversion 1.8 and later using the [ hook script environment] configuration. Rather than directly editing `trac-svn-hook` to set the environment variables, or exporting them from the hook that invokes `trac-svn-hook`, they can be configured through the repository `conf/hooks-env` file.
     164Here is an example, using a Python virtual environment at `/usr/local/venv`:
     171===== Writing Your Own Hook Script
     173The 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`):
     176export PYTHON_EGG_CACHE="/path/to/dir"
     177/usr/bin/trac-admin /path/to/env changeset added "$1" "$2"
     179Adapt the path to the actual location of `trac-admin`.
     180On Windows (`post-commit.cmd`):
     182@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset added "%1" "%2"
     185The post-revprop-change hook for Subversion is very similar. On Unix (`post-revprop-change`):
     188export PYTHON_EGG_CACHE="/path/to/dir"
     189/usr/bin/trac-admin /path/to/env changeset modified "$1" "$2"
     191On Windows (`post-revprop-change.cmd`):
     193@C:\Python26\Scripts\trac-admin.exe C:\path\to\env changeset modified "%1" "%2"
     196The 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`.
     198See the [ section about hooks] in the Subversion book for more information. Other repository types will require different hook configuration.
     200==== Git
     202[ Git hooks] can be used in the same way for explicit syncing of Git repositories.
     204If your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo:
     207tracenv=/path/to/env  # set to your Trac environment's path
     208repos=                # set to your repository's name
     209while read oldrev newrev refname; do
     210    if [ "$oldrev" = 0000000000000000000000000000000000000000 ]; then
     211        git rev-list --reverse "$newrev" --
     212    else
     213        git rev-list --reverse "$newrev" "^$oldrev" --
     214    fi | xargs trac-admin "$tracenv" changeset added "$repos"
     217The `repos` variable is the repository name (use `"(default)"` for the default repository).
     219Alternatively, 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 repository:
     222tracenv=/path/to/env  # set to your Trac environment's path
     223repos=                # set to your repository's name
     224REV=$(git rev-parse HEAD)
     225trac-admin "$tracenv" changeset added "$repos" $REV
     227The `post-commit` hook will do nothing if you only update the repository by pushing to it.
     229Be sure to set the hook scripts as executable.
     231==== Mercurial
     233For 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/] and place it somewhere accessible):
     236; If mercurial-plugin is installed globally
     237commit = python:tracext.hg.hooks.add_changesets
     238changegroup = python:tracext.hg.hooks.add_changesets
     240; If mercurial-plugin is installed in a Trac plugins directory
     241commit = python:/path/to/
     242changegroup = python:/path/to/
     245env = /path/to/env
     246trac-admin = /path/to/trac-admin
     249=== Per-request synchronization #PerRequestSync
     250If the post-commit hooks are not available, the environment can be set up for per-request synchronization. The `sync_per_request` attribute for each repository in the database and in [wiki:TracIni#trac-section trac.ini] must be set to `true`.
     252Note that in this case, the changeset listener extension point is not called, and therefore plugins that depend on the changeset added and modified events won't work correctly. For example, automatic changeset references cannot be used with implicit synchronization.
     254== Automatic changeset references in tickets #CommitTicketUpdater
     256You 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 patterns:
     257 * '''`Refs #123`''' - to reference this changeset in `#123` ticket
     258 * '''`Fixes #123`''' - to reference this changeset and close `#123` ticket with the default status ''fixed''
     260This functionality requires installing a post-commit hook as described in [#ExplicitSync explicit synchronization], and enabling the optional commit updater components through the //Plugins// admin panel or by adding the following line to the `[components]` section of your [wiki:TracIni#components-section trac.ini]:
     262tracopt.ticket.commit_updater.* = enabled
     264For more information, see the documentation of the `CommitTicketUpdater` component in the //Plugins// admin panel and the [trac:CommitTicketUpdater] page.
     266== Troubleshooting
     268=== My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook
     270You must now use the optional components from `tracopt.ticket.commit_updater.*`, which you can activate through the //Plugins// admin page, or by directly modifying the [TracIni#components-section "[components]"] section in the trac.ini. Be sure to use [#ExplicitSync explicit synchronization].
     272See [trac:CommitTicketUpdater#Troubleshooting] for more troubleshooting tips.
     274=== Git control files missing
     276If your repository is not browseable and you find a message in the log that looks like:
     2782017-08-08 10:49:17,339 Trac[PyGIT] ERROR: GIT control files missing in '/path/to/git-repository'
     2792017-08-08 10:49:17,339 Trac[git_fs] ERROR: GitError: GIT control files not found, maybe wrong directory?
     282First check that the path to your repository is correct. If the path is correct, you may have a permission problem whereby the web server cannot access the repository. You can use Git to verify the repository. On a Debian-like Linux OS, the following command should help:
     284$ sudo -u www-data git --git-dir=/path/to/git-repository fsck
     287On other platforms you may need to modify the command to use the user under which the webserver runs.