Changes between Version 12 and Version 13 of GitHubSyncPlugin


Ignore:
Timestamp:
Apr 11, 2022, 6:23:58 AM (2 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • GitHubSyncPlugin

    v12 v13  
    55== Description
    66
    7 This plugin synchronises a GitHub repository with a local repository used by Trac.
     7This 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.
    88
    9 When a GitHub repository is changed, this plugin pulls those changes into the local repository.
     9After 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.
    1010
    11 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.
     11The 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.
    1212
    13 Name of the repository on GitHub should match (it is case sensitive) 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.
     13The plugin automatically triggers the `trac-admin changeset added` command with new revisions after every fetch, so applying ticket updates through commit messages is possible.
    1414
    15 Plugin automatically triggers `trac-admin changeset added` command with new revisions after every fetch, so ticket updates through commit messages is possible.
    16 
    17 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.
     15For 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.
    1816
    1917== Bugs/Feature Requests