= GitHub sync plugin =

== Description ==

This plugin syncs GitHub repository with local repository used by Trac.

When a GitHub repository is changed, this plugin pulls those changes into the local repository.

After installation of this plugin, you have to configure GitHub to notify Trac about changes. You do this on GitHub under ''Admin'' -> ''Service Hooks'' section, where you select ''Post-Receive URLs'' service hook type and enter an URL of your Trac installation's `/githubsync` handler. For example, if your Trac installation is on `http://www.example.com/` then enter `http://www.example.com/githubsync` as service hook URL.

Name of the repository on GitHub should match the local one (you can use aliases in Trac 0.12 to assure that). User under which Trac is running on the server should have write access to the local repository for which it is configured and you want to sync.

Of course, local repository should be properly configured into Trac (post-receive hook configured and so on). Then also ticket updates through commit messages is possible.

== Bugs/Feature Requests ==

Please use [https://bitbucket.org/mitar/trac-githubsync/issues Bitbucket] for any issues you have with GitHubSyncPlugin.

== Download ==

Download the zipped source from [https://bitbucket.org/mitar/trac-githubsync/get/tip.zip here].

== Source ==

You can clone GitHubSyncPlugin from [https://bitbucket.org/mitar/trac-githubsync here] using Mercurial, or [https://bitbucket.org/mitar/trac-githubsync/src browse the source] on Bitbucket.

== Installation ==

Please follow [http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin documentation] on how to install Trac's plugins.

== Author/Contributors ==

'''Author:''' [wiki:mitar] [[BR]]
'''Maintainer:''' [wiki:mitar] [[BR]]
'''Contributors:'''