wiki:GitHubSyncPlugin

Synchronise a GitHub repository with a local Trac repository

Description

This plugin synchronises a GitHub repository with a 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 code 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 the service hook URL.

The name of the repository on GitHub should match with the local repository and you can use aliases in Trac 0.12 to assure that. Repository names are case sensitive. The 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.

The plugin automatically triggers the trac-admin changeset added command with new revisions after every fetch, so applying ticket updates through commit messages is possible.

For testing, use GitHub's Test Hook. Opening http://www.example.com/githubsync in the browser will not work, because POST request is required, not GET request.

Bugs/Feature Requests

Please use GitHub for any issues you have with GitHubSyncPlugin.

Download

Download the zipped source from here.

Source

You can clone GitHubSyncPlugin from here using git, or browse the source on GitHub.

Installation

This plugin can be installed by running the following:

pip install GitHubSyncPlugin

For more information, please follow documentation on how to install Trac's plugins.

Author/Contributors

Author: mitar
Maintainer: mitar
Contributors:

Last modified 3 years ago Last modified on Apr 11, 2022, 6:23:58 AM