Git Plugin for Trac
- Browsing source code in a Git repository via the TracBrowser
- Viewing the change history of a file or directory using TracRevisionLog
- Performing diffs between any two files or two directories
- Displaying submitted changes in the TracTimeline (0.11)
- (Optionally) caching TracChangeset information in Trac's database (0.11)
- Caching Git commit relation graph in memory (0.11)
- Using the TracSearch page to search change descriptions (0.11)
- Annotation support, also known as "blame" operation (0.11)
- Interpretation of 40-character wide hex-strings as sha1 commit checksums
|GIT||1.4.4+|| 1.5.2+ (for plugin v0.11.0.1) |
1.5.6+ (for plugin v0.11.0.2+)
If you have any issues, create a new ticket (1.0+).
Help is highly appreciated, since I have very little spare time these days as can be seen in the commit history. Feel free to fork GitPlugin on GitHub and improve or fix things.
The source code is hosted at GitHub
(An experimental branch of this plugin with a hacky caching feature and some bug fixes is available from here.)
For Trac 0.11:
or alternatively the Python 2.4 backport:
For Trac 0.12
This is a rare case where pip is probably more of a hassle than easy_install. pip, by design, does not generate the .egg file for you, which Trac needs.
See also wiki:TracIni#git-section of your current Trac installation (if GitPlugin is enabled), for an up-to-date list of customizable [git] settings.
[trac] # simple single-repository configuration repository_dir = /var/git/Test.git repository_type = git ## the following settings are only supported for plugin version 0.11 or later [git] ## let Trac cache meta-data via CachedRepository wrapper; default: false cached_repository = true ## disable automatic garbage collection for in-memory commit-tree cache; default: false persistent_cache = true ## length revision sha-sums should be tried to be abbreviated to (must be >= 4 and <= 40); default: 7 shortrev_len = 6 ## (0.12.0.3+) minimum length for which hex-strings will be interpreted as commit ids in wiki context; default: 40 wiki_shortrev_len = 7 ## executable file name (in case of doubt use absolute path!) of git binary; default: 'git' git_bin = /usr/src/git-dev/git ## (0.12.0.5+) define charset encoding of paths stored within git repository; default: 'utf-8' git_fs_encoding = latin1 ## (0.12.0.3+) enable reverse mapping of git email addresses to trac user ids; default: false trac_user_rlookup = true ## (0.12.0.3+) use git-committer id instead of git-author id as changeset owner; default: true use_committer_id = false ## (0.12.0.3+) use git-committer timestamp instead of git-author timestamp as changeset time; default: true use_committer_time = false
TODO: write about current issues wrt GitPlugin and how to workaround them
post-receive hook scripts
For Trac 0.11 see attachments below.
With Trac 0.12 a VC independent plugin approach to handling ticket references in commit messages has been put into place. Thus for 0.12 in you basically need to enable the CommitTicketUpdater component in trac.ini or via the webinterface under 'Admin/Plugins'. Additionally you have to call trac-admin TRAC_ENV changeset added <commitid(s)>, e.g. by putting a post-receive script into your_repository.git/hooks/. Won't work as intended before #7301 is fixed.
Two examples are available as attachments.
trac-post-receive-hook-0.12-only-master.py - example that adds to Trac only commits to the master (or other specified) branch
trac-post-receive-hook-0.12-new-commits-from-all-branches.py - example that adds to Trac all commits, ensuring that every commit is added only once.
trac-post-receive-hook-0.12-new-commits-from-all-branches-with-logfile.py - the previous one, but with a little change in the REPO_NAME, and adding a log file to detect error. I have not tested it with other repositories different to the default one. I suggest that to use one of the two post-receive files, take in consideration the user's permission for exec (I suggest in debian use the user git that belongs to the group www-data):
To test post-receive
/srv/git/myrepo/.git/hooks/trac-post-receive-hook-0.12-new-commits-from-all-branches-with-logfile.py &>> /tmp/tracgitplugin.log
/srv/git/myrepo/.git/hooks/trac-post-receive-hook-0.12-new-commits-from-all-branches-with-logfile.py &> /dev/null
Its is important that your git user have access to read the trac.ini and his directory, and also modify access to the trac.db file and his directory as well. This is made by adding the git to the apache2 group (in debian www-data group). If you use log file configured in your trac.ini, it is important that the user have the modify permission also, and the directory as well.
If you are using Gitorious, there is a CGI script, you can configure as WebHook.
Enabling the Component
You will also need to change your trac.ini file accordingly. Thus repository_sync_per_request under the trac section is to be unset, and tracopt.ticket.commit_updater.* under component are to be set to enabled. e.g. :
[trac] repository_dir = /path/to/git/repos.git/ repository_sync_per_request = ... [components] tracext.git.* = enabled tracopt.ticket.commit_updater.committicketreferencemacro = enabled tracopt.ticket.commit_updater.committicketupdater = enabled ...
Also make sure that the user executing the trac-admin command has read access to your TRAC_ENV and write access to your trac.log as well as to your trac database.
/!\ NOTES :
- the Test.git in the configuration section above needs to be the .git repository directory (i.e. the one containing the file HEAD and config), not the working tree directory that holds the .git/ folder.
- Wrong permissions may also be the cause of the error !GitError: GIT control files not found, maybe wrong directory?. Make sure the repository_dir argument is accessible via git by the tracd process.
- If you are noticing a slow down in trac with a repository above 500 commits, try disabling the caching. It seems to bog things down as a repo grows.
- If installed globally, don't forget to enable the plugin:
[components] # for plugin version 0.10 gitplugin.* = enabled # for plugin version 0.11.0.1+ tracext.git.* = enabled
- If on Trac 0.12 you don't see the shortrev and commit branch, you probably have caching enabled (cached_repository = true, persistent_cache = true). Set those to false.
Author: Herbert Valerio Riedel
Contributors: Hans Petter Jansson, Juan Fernando Jaramillo
- trac-post-receive-hook.py (7.2 kB) -
post-receive hook for closing and referencing tickets, added by email@example.com on 08/14/09 16:39:06.
- trac-post-receive-hook.2.py (7.3 kB) -
post-receive hook for closing and referencing tickets, added by firstname.lastname@example.org on 08/14/09 16:42:52.
- trac-post-receive-hook.3.py (7.5 kB) -
post-receive hook for closing and referencing tickets - now auto-creating git_seen table, added by cameronsstone on 09/07/09 08:11:46.
- trac-post-receive-hook-0.12-only-master.py (0.9 kB) -
Old example from main site, added by silk on 11/29/10 13:35:32.
- trac-post-receive-hook-0.12-new-commits-from-all-branches.py (2.2 kB) -
Add commits from all branches, but only those that are new to the repository. Properly handles many branches in one push. Added version number., added by silk on 09/16/11 11:03:36.
- trac-post-receive-hook-0.12-new-commits-from-all-branches-with-logfile.py (2.5 kB) -
Correction of the previous version, and add log file to detect errors., added by email@example.com on 02/18/12 15:58:43.
- trac-post-receive-hook.4.py (7.5 kB) -
post-receive hook for closing and referencing tickets - updated to trac 1.0; fixed syntax; removed unused imports, added by firstname.lastname@example.org on 03/29/13 14:32:01.