| 4 | | == クイックスタート == #QuickStart |
| 5 | | |
| 6 | | * リポジトリの管理は、 "リポジトリ" (英語版では "Repository") 管理パネル、 `trac-admin` または、 [wiki:TracIni#repositories-section trac.ini] の `[repositories]` セクションで管理します |
| 7 | | * 各リポジトリの post-commit フックに `trac-admin $ENV changeset added $REPO $REV` を実行するよう設定して下さい。さらに、リポジトリのリビジョンのプロパティが変更されたときのために、 post-revprop-change フックに `trac-admin $ENV changeset modified $REPO $REV` を追加してください |
| 8 | | * `[trac] repository_sync_per_request` オプションを empty 値に設定し、リクエスト毎の同期を行なわないようにします |
| 9 | | * Subversion のフックを実行するユーザが Trac environment に対して書き込み権限を持っていることを確認して下さい。もしくは、一時的に権限を高める `sudo` のようなツールを使って下さい |
| 10 | | |
| 11 | | == リポジトリを指定する == #Repositories |
| 12 | | バージョン 0.12 から Trac は 1 つの Trac Environment に対して 1 つ以上のリポジトリを扱えるようになりました。 0.12 以前の [wiki:TracIni trac.ini] の `[trac]` セクションの `repository_dir` と `repository_type` オプションでリポジトリを指定する方法もサポートしていますが、 2 つの新しいメカニズムにより、 Trac Environment にリポジトリを追加することができます。 |
| 13 | | |
| 14 | | リポジトリのエイリアスを定義することも可能です。エイリアスは実際のリポジトリへの "ポインタ" となります。これはリポジトリの名前変更を行なったときに古い名前へのリンク切れを防ぐのに便利です。 |
| 15 | | |
| 16 | | 各リポジトリに関連したいくつかの属性があり、リポジトリのロケーション、名前、リポジトリブラウザでどのように表示されるかを定義できます。下記の属性がサポートされています: |
| 17 | | |
| 18 | | ||='''属性''' =||='''概要''' =|| |
| | 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 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. |
| | 10 | |
| | 11 | == Enabling the components |
| | 12 | |
| | 13 | Support 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 | |
| | 15 | The 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. |
| | 16 | |
| | 17 | {{{#!ini |
| | 18 | tracopt.versioncontrol.svn.* = enabled |
| | 19 | }}} |
| | 20 | |
| | 21 | {{{#!ini |
| | 22 | tracopt.versioncontrol.git.* = enabled |
| | 23 | }}} |
| | 24 | |
| | 25 | == Specifying repositories #Repositories |
| | 26 | |
| | 27 | Trac 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. |
| | 28 | |
| | 29 | You 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. |
| | 30 | |
| | 31 | It 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. |
| | 32 | |
| | 33 | === Default Repository |
| | 34 | |
| | 35 | Trac'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. |
| | 36 | |
| | 37 | From 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`). |
| | 38 | |
| | 39 | === Repository Attributes |
| | 40 | |
| | 41 | There 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. |
| | 42 | |
| | 43 | The following attributes are supported: |
| | 44 | |
| | 45 | ||='''Attribute''' =||='''Description''' =|| |
| 24 | | ||`dir` 属性はファイルシステム内におけるリポジトリのロケーションを指定します。これは以前に設定していた `[trac] repository_dir` と一致するものです。 `alias` 属性と `dir` 属性は相反する設定です。 || |
| 25 | | ||`hidden` ||`true` に設定すると、リポジトリブラウザのインデックスのページから見えなくなります。それでもなお、リポジトリをブラウズすることはできますし、リポジトリを参照するリンクは有効です。 || |
| 26 | | ||`type` ||`type` 属性はリポジトリが使用しているバージョン管理システムのタイプを設定します。 Trac は Subversion を当初からサポートしており、プラグインを使用して他のシステムをサポートします。もし `type` 属性が指定されていなかったら、 `[trac] repository_type` オプションの値が使用されます。 || |
| 27 | | ||`url` ||`url` 属性はリポジトリからチェックアウトするときに使用するルートのURLを指定します。指定された場合、 "リポジトリ URL" リンクがリポジトリブラウザのナビゲーションコンテキストに追加されます。 URL はツールにコピーすることができるので、ワーキングコピーを作るときに使用できます。 || |
| 28 | | |
| 29 | | リポジトリの `name` 属性と`alias` 属性または `dir` 属性は必須項目です。他の項目はオプションです。 |
| 30 | | |
| 31 | | リポジトリを追加した後、そのリポジトリのキャッシュは `trac-admin $ENV repository resync` コマンドで再同期されなければなりません。 |
| 32 | | |
| 33 | | `repository resync <repos>`:: |
| 34 | | Trac とリポジトリを再同期する。 |
| 35 | | |
| 36 | | |
| 37 | | === ファイル (`trac.ini`) を使用した設定 === #ReposTracIni |
| 38 | | リポジトリとリポジトリの属性は [wiki:TracIni#repositories-section trac.ini] の `[repositories]` セクションで設定することができます。すべてのキーは `{name}.{attribute}` という規則で構成されていて、キーに対応する値は、等号 (`=`) で区切られています。デフォルトのリポジトリの名前は empty になります。 |
| 39 | | |
| 40 | | `trac.ini` でリポジトリを設定する主たる利点は、グローバルな設定から継承できることです ( TracIni の [wiki:TracIni#GlobalConfiguration グローバルな設定 ] 参照 ) 欠点は、 `trac.ini` をパースするのに使用されている `ConfigParser` クラスの制限事項として、リポジトリ名が常に小文字しか受け付けないということです。 |
| 41 | | |
| 42 | | 下記の例では `project`, `lib` という 2 つのSubversion リポジトリが定義し、デフォルトのリポジトリとして `project` にエイリアスが設定されています。これは以前に Trac Environment が単一のリポジトリ ( `project` リポジトリ ) だったものを、複数のリポジトリに変換した際の典型的な使用例です。エイリアスは設定変更前から存在するリンクが `project` リポジトリを解決できることを保証します。 |
| 43 | | {{{ |
| 44 | | #!ini |
| | 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. || |
| | 56 | ||`sync_per_request`||\ |
| | 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. || |
| | 62 | |
| | 63 | === Scoped Repository |
| | 64 | |
| | 65 | For 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. |
| | 66 | |
| | 67 | For 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`: |
| | 68 | {{{#!ini |
| | 69 | proj1.dir = /var/svn/repos1/proj1 |
| | 70 | proj1.type = svn |
| | 71 | }}} |
| | 72 | |
| | 73 | For other repository types, check the corresponding plugin's documentation. |
| | 74 | |
| | 75 | === In the database #ReposDatabase |
| | 76 | Repositories can also be specified in the database, using either the //Repositories// admin page under //Version Control//, or the `trac-admin $ENV repository` commands. |
| | 77 | |
| | 78 | The 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. |
| | 79 | |
| | 80 | The following [wiki:TracAdmin trac-admin] commands can be used to perform repository operations from the command line. |
| | 81 | |
| | 82 | `repository add <repos> <dir> [type]`:: |
| | 83 | Add a repository `<repos>` located at `<dir>`, and optionally specify its type. |
| | 84 | |
| | 85 | `repository alias <name> <target>`:: |
| | 86 | Create an alias `<name>` for the repository `<target>`. |
| | 87 | |
| | 88 | `repository remove <repos>`:: |
| | 89 | Remove the repository `<repos>`. |
| | 90 | |
| | 91 | `repository set <repos> <key> <value>`:: |
| | 92 | Set the attribute `<key>` to `<value>` for the repository `<repos>`. |
| | 93 | |
| | 94 | Note 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. |
| | 95 | |
| | 96 | === In `trac.ini` #ReposTracIni |
| | 97 | Repositories 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. |
| | 98 | |
| | 99 | The 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. |
| | 100 | |
| | 101 | The 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. |
| | 102 | {{{#!ini |
| 59 | | Note: `name.alias = target` の場合、 `name` を `target` リポジトリへのエイリアスにします。他の方法がありません。 |
| 60 | | |
| 61 | | === データベースを使用した設定 === #ReposDatabase |
| 62 | | リポジトリは (trac.ini ファイルではなく) データベース内でも設定することができます。 "バージョンコントロール" (英語版では "Version Control") 配下の "リポジトリ" 管理パネル、もしくは `trac-admin $ENV repository` コマンドを使用します。 |
| 63 | | |
| 64 | | 管理パネルは Trac Environment 内に定義されているすべてのリポジトリのリストを表示します。リポジトリ、エイリアスの追加、リポジトリの属性の編集、リポジトリの削除ができます。 `trac.ini` に定義されているリポジトリもまた表示されますが、編集はできません。 |
| 65 | | |
| 66 | | 以下の [wiki:TracAdmin trac-admin] コマンドはコマンドラインからリポジトリを操作する際に使用します。 |
| 67 | | |
| 68 | | `repository add <repos> <dir> [type]`:: |
| 69 | | `<dir>` にあるリポジトリ `<repos>` を Trac に追加し、オプションとして、リポジトリのタイプを指定します。 |
| 70 | | |
| 71 | | `repository alias <name> <target>`:: |
| 72 | | リポジトリ `<target>` のエイリアス `<name>` を設定します。 |
| 73 | | |
| 74 | | `repository remove <repos>`:: |
| 75 | | リポジトリ `<repos>` を削除します。 |
| 76 | | |
| 77 | | `repository set <repos> <key> <value>`:: |
| 78 | | リポジトリ `<repos>` の属性 `<key>` と `<value>` を設定します。 |
| 79 | | |
| 80 | | Note: デフォルトリポジトリはの名前は空文字列です。したがって、 `trac-admin` をシェルから起動させたときは、おそらくクオートする必要があるでしょう。代替手段として、例えば `trac-admin` を対話モードで起動しているときは、代わりに "`(default)`" を使用することができます。 |
| 81 | | |
| 82 | | |
| 83 | | == リポジトリの同期 == #Synchronization |
| 84 | | Trac 0.12 以前では、HTTP リクエストが発生するたびに Trac が持つキャッシュとリポジトリの同期処理を行なっていました。このアプローチは効果的ではなく、複数のリポジトリを扱う上ではもはや実用的ではありません。この理由から、 post-commit フックを利用した明示的な同期処理が追加されました。 |
| 85 | | |
| 86 | | リポジトリの変更を監視する拡張ポイントを定義するインタフェース ''(IRepositoryChangeListener)'' が追加されました。このインタフェースの呼び出しは、チェンジセットが追加または修正されたときの post-commit フックをトリガーとしています。コミット時に何かしらのアクションを実行するプラグインで使用することができます。 |
| 87 | | |
| 88 | | === Mercurial リポジトリ === #MercurialRepositories |
| 89 | | このドキュメントを書いている時点では、 Mercurial 導入時の同期作業やフックは必要ではありません - 詳細は [trac:#9485 本家チケット 9485] を参照して下さい。 |
| 90 | | |
| 91 | | === 明示的な同期 === #ExplicitSync |
| 92 | | これは推奨するリポジトリの同期方法です。 [wiki:TracIni#trac-section trac.ini] の `[trac] repository_sync_per_request` オプションを empty 値に設定する必要があります。そして、各リポジトリの post-commit フック内で `trac-admin` を呼び出すようにします。さらに、リポジトリでリビジョンのメタデータを変更することが許されているならば、 post-revprop-change フックにも同様に `trac-admin` を呼び出すように設定します。 |
| | 117 | Note that `name.alias = target` makes `name` an alias for the `target` repo, not the other way around. |
| | 118 | |
| | 119 | === In !GitWeb #ReposGitWeb |
| | 120 | |
| | 121 | [https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb 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]]. |
| | 122 | |
| | 123 | == Repository caching |
| | 124 | |
| | 125 | Caching 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. |
| | 126 | |
| | 127 | Repositories 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`. |
| | 128 | |
| | 129 | After adding a cached repository, the cache must be populated with the `trac-admin $ENV repository resync` command. |
| | 130 | |
| | 131 | `repository resync <repos>`:: |
| | 132 | Re-synchronize Trac with a repository. |
| | 133 | |
| | 134 | == Repository synchronization #Synchronization |
| | 135 | |
| | 136 | Either 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. |
| | 137 | |
| | 138 | === Explicit synchronization #ExplicitSync |
| | 139 | |
| | 140 | This 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. |
| 98 | | Trac に 1 つ以上のチェンジセットに対するメタデータの変更がリポジトリに加えられたことを知らせる。 |
| 99 | | |
| 100 | | 引数 `<repos>` にはリポジトリ名 ( デフォルトのリポジトリには "`(default)`" を使用する ) または、リポジトリへのパスを指定します。 |
| 101 | | |
| 102 | | Note: もし PYTHON_EGG_CACHE のロケーションをデフォルトから変更している場合、 trac-admin を起動する前にウェブサーバと同じ値の PYTHON_EGG_CACHE を環境変数として設定しないといけないかもしれません。詳細については、 [wiki:TracPlugins Trac プラグイン] を参照して下さい。 |
| 103 | | |
| 104 | | 下記は、 Subversion の完璧な post-commit と post-revprop-change スクリプトの一例です。特定の環境用に編集、そして適切な実行権を付けて 各リポジトリの `hooks` ディレクトリにおいてください。 UNIX における (`post-commit`) 例: |
| | 146 | Notify Trac that metadata on one or more changesets in a repository has been modified. |
| | 147 | |
| | 148 | The `<repos>` argument can be either a repository name (use `"(default)"` for the default repository) or the path to the repository. |
| | 149 | |
| | 150 | 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#Settinguptheplugincache TracPlugins] for more information. |
| | 151 | |
| | 152 | ==== Subversion |
| | 153 | |
| | 154 | ===== Using `trac-svn-hook` |
| | 155 | |
| | 156 | In 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. |
| | 157 | |
| | 158 | There'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. |
| | 159 | |
| | 160 | Follow 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. |
| | 161 | |
| | 162 | Configuring the hook environment variables is even easier in Subversion 1.8 and later 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, or exporting them from the hook that invokes `trac-svn-hook`, they can be configured through the repository `conf/hooks-env` file. |
| | 163 | |
| | 164 | Here is an example, using a Python virtual environment at `/usr/local/venv`: |
| | 165 | {{{#!ini |
| | 166 | [default] |
| | 167 | TRAC_ENV=/var/trac/project-1 |
| | 168 | TRAC_PATH=/usr/local/venv/bin |
| | 169 | }}} |
| | 170 | |
| | 171 | ===== Writing Your Own Hook Script |
| | 172 | |
| | 173 | The 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`): |
| 132 | | 上記の UNIX の変数は、 Subversion のコミットの実行ユーザが Trac に対して、書き込み権限があると仮定したもので、リポジトリと Trac の両方がウェブサーバを使って、動作している一般的な設定に基づいています。もし、ウェブサーバ経由以外での方法でリポジトリにアクセス (例: `svn+ssh://` ) しているならば、 `trac-admin` を別の権限で起動 (例: `sudo` コマンド ) しなければならないかもしれません。 |
| 133 | | |
| 134 | | Note: Subversion のフックで `trac-admin` を呼び出すことは、クライアントサイドにおいては、コミットとログの編集操作に時間がかかってしまうことになります。非同期な方法で行なうために、 `trac-admin` で始まる [http://trac.edgewall.org/browser/trunk/contrib/trac-svn-hook contrib/trac-svn-hook] を使いたいと思うかもしれません。スクリプトもまた何回もの安全性のチェックと使い方のアドバイスを行なっているので、フックを設定したりテストするのはずっと簡単なことかもしれません。まだ Windows 用の `trac-svn-hook.bat` に匹敵するものはありませんが、スクリプトは Cygwin の bash で起動することができます。 |
| 135 | | |
| 136 | | より詳しい情報は、Subversion 本の [http://svnbook.red-bean.com/en/1.5/svn.reposadmin.create.html#svn.reposadmin.create.hooks フックについて] を参照して下さい。他のリポジトリのタイプでは異なるフックの設定が必要です。 |
| 137 | | |
| 138 | | Git フックは、 Git リポジトリの同期と同じように使用することができます。`.git/hooks/post-commit` に以下を追加します: |
| 139 | | {{{#!sh |
| 140 | | REV=$(git rev-parse HEAD) |
| 141 | | trac-admin /path/to/env changeset added <my-repository> $REV |
| 142 | | }}} |
| 143 | | |
| 144 | | Mercurial では、 Trac にアクセスされるリポジトリ毎の `.hgrc` ファイルに以下を追加します。 ([trac:TracMercurial] が Trac の `plugins` ディレクトリにインストールされている場合、 [trac:source:mercurial-plugin/tracext/hg/hooks.py hooks.py] をダウンロードし、どこかアクセス可能な場所に格納してください) : |
| | 196 | The 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`. |
| | 197 | |
| | 198 | See 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 configuration. |
| | 199 | |
| | 200 | ==== Git |
| | 201 | |
| | 202 | [https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks Git hooks] can be used in the same way for explicit syncing of Git repositories. |
| | 203 | |
| | 204 | If your repository is one that only gets pushed to, add the following to the `hooks/post-receive` file in the repo: |
| | 205 | {{{#!sh |
| | 206 | #!/bin/sh |
| | 207 | tracenv=/path/to/env # set to your Trac environment's path |
| | 208 | repos= # set to your repository's name |
| | 209 | while 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" |
| | 215 | done |
| | 216 | }}} |
| | 217 | The `repos` variable is the repository name (use `"(default)"` for the default repository). |
| | 218 | |
| | 219 | Alternatively, 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: |
| | 220 | {{{#!sh |
| | 221 | #!/bin/sh |
| | 222 | tracenv=/path/to/env # set to your Trac environment's path |
| | 223 | repos= # set to your repository's name |
| | 224 | REV=$(git rev-parse HEAD) |
| | 225 | trac-admin "$tracenv" changeset added "$repos" $REV |
| | 226 | }}} |
| | 227 | The `post-commit` hook will do nothing if you only update the repository by pushing to it. |
| | 228 | |
| | 229 | Be sure to set the hook scripts as executable. |
| | 230 | |
| | 231 | ==== Mercurial |
| | 232 | |
| | 233 | For 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): |
| 160 | | === リクエスト毎の同期処理 === #PerRequestSync |
| 161 | | もし post-commit フックが使用できないならば、その環境ではリクエスト毎の同期処理を設定することができます。この場合、 [wiki:TracIni#trac-section trac.ini] のオプション `[trac] repository_sync_per_request` に同期対象のリポジトリをカンマ区切りでリストしなければなりません。 |
| 162 | | |
| 163 | | Note: この場合、チェンジセットのリスナの拡張ポイントは呼び出されません。それゆえ、使用しているプラグインは正しく動かないかもしれません。 |
| 164 | | |
| 165 | | |
| 166 | | == 単一リポジトリからの移行手順 (Subversion) == #Migration |
| 167 | | 下記の手順は、 Subversion における単一リポジトリから複数のリポジトリの設定へ変更するための典型的な移行方法になります。 |
| 168 | | |
| 169 | | 1. `[trac] repository_dir` オプションからリポジトリのデフォルトの設定を削除する |
| 170 | | 1. メインとなるリポジトリを名前付きのリポジトリとして登録する |
| 171 | | 1. メインのリポジトリを再同期する |
| 172 | | 1. post-commit フックと post-revprop-change フックをメインのリポジトリに設定し、 `[trac] repository_sync_per_request` オプションに empty 値を設定します |
| 173 | | 1. デフォルトリポジトリとしてメインリポジトリに alias 属性を追加します。 (`name` は除外。つまり、`.alias = main`)。これは移行前に作成されたすべてのリンクがメインリポジトリを解決できることを保証します |
| 174 | | 1. ステップ 2,3,4 を他の "名前付きの" リポジトリに対して必要に応じて繰り返します |
| 175 | | |
| 176 | | == 単一リポジトリからの移行手順 (Mercurial) == #MigrationMercurial |
| 177 | | 下記の手順は、 Mercurial における単一リポジトリから複数のリポジトリの設定へ変更するための典型的な移行方法になります。このドキュメントを執筆している時点では、 Mercurial 導入時の同期作業やフックは必要ではありません - 詳細は [trac:#9485 本家チケット 9485] を参照して下さい。 |
| 178 | | |
| 179 | | 1. TracMercurial プラグインを最新バージョンにアップグレードします |
| 180 | | 1. デフォルトリポジトリの設定を trac.ini の `[trac] repository_dir` オプションから削除します |
| 181 | | 1. メインとなるリポジトリを名前付きのリポジトリとして追加します |
| 182 | | 1. デフォルトリポジトリとしてメインリポジトリに alias 属性を追加します。 (`name` は除外。つまり、`.alias = main`)。これは移行前に作成されたすべてのリンクがメインリポジトリを解決できることを保証します |
| 183 | | 1. ステップ 3 を他の "名前付きの" リポジトリに対して必要に応じて繰り返します |
| 184 | | |
| 185 | | == トラブルシューティング == #Troubleshooting |
| 186 | | |
| 187 | | === trac-post-commit-hook はもはや機能しません === #trac-post-commit-hook |
| 188 | | |
| 189 | | 今では、 `tracopt.ticket.commit_updater.*` のオプションのコンポーネントを使用しなければなりません。 Web からの管理の一般設定配下のプラグインパネルか trac.ini の [TracIni#components-section "[components]"] セクションを直接編集することによって有効にすることができます。上記で説明している [#ExplicitSync 明示的な同期] を確実に行なってください。 |
| | 249 | === Per-request synchronization #PerRequestSync |
| | 250 | If 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`. |
| | 251 | |
| | 252 | Note 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. |
| | 253 | |
| | 254 | == Automatic changeset references in tickets #CommitTicketUpdater |
| | 255 | |
| | 256 | You 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'' |
| | 259 | |
| | 260 | This 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]: |
| | 261 | {{{#!ini |
| | 262 | tracopt.ticket.commit_updater.* = enabled |
| | 263 | }}} |
| | 264 | For more information, see the documentation of the `CommitTicketUpdater` component in the //Plugins// admin panel and the [trac:CommitTicketUpdater] page. |
| | 265 | |
| | 266 | == Troubleshooting |
| | 267 | |
| | 268 | === My trac-post-commit-hook doesn't work anymore #trac-post-commit-hook |
| | 269 | |
| | 270 | You 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]. |
| | 271 | |
| | 272 | See [trac:CommitTicketUpdater#Troubleshooting] for more troubleshooting tips. |
| | 273 | |
| | 274 | === Git control files missing |
| | 275 | |
| | 276 | If your repository is not browseable and you find a message in the log that looks like: |
| | 277 | {{{ |
| | 278 | 2017-08-08 10:49:17,339 Trac[PyGIT] ERROR: GIT control files missing in '/path/to/git-repository' |
| | 279 | 2017-08-08 10:49:17,339 Trac[git_fs] ERROR: GitError: GIT control files not found, maybe wrong directory? |
| | 280 | }}} |
| | 281 | |
| | 282 | First 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: |
| | 283 | {{{#!sh |
| | 284 | $ sudo -u www-data git --git-dir=/path/to/git-repository fsck |
| | 285 | }}} |
| | 286 | |
| | 287 | On other platforms you may need to modify the command to use the user under which the webserver runs. |
![(trac.ini の [header_logo] セクションを設定してください)](/trac/pj/chrome/site/Title.png)
