cogAllows committing content of wiki pages to a GitHub repository
TypeXAR
Developed by

Ludovic Dubost

Active Installs10
Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Installable with the Extension Manager

Description

The GitHub App allows to detect changes to XWiki pages commited in GitHub and to commit XWiki pages to GitHub directly (there's no local clone done) as well as update pages from GitHub. As a nice bonus GitHubApp can generate your maven pom for your XWiki XAR module.

Some screenshots below:

GitHubAppConfig.png

GitHubCommit.png

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
1.0XWiki Enterprise XWiki Enterprise 3.3
1.1XWiki Enterprise XWiki Enterprise 4.5
1.2.1XWiki Enterprise XWiki Enterprise 6.0.1
1.3XWiki Enterprise XWiki Enterprise 6.2

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Version 1.3 installs through Extension Manager. Version 1.2.1 and before can be installed manually.

Release Notes

v1.3.2

  • Fix an exception in a debug function when accessing an existing project

v1.3.1

  • Naming changes

v1.3

Latest version of GitHubApp which supports installation through extension manager.

This version supports also formatting of the XML files compatible with the maven xar plugin.

In version 1.3 it is now necessary to provide your email in addition to your username. It is important to update your old configs and to put the correct email, otherwise GitHub will still accept your commits but not linked them properly to your user account.

v1.2.1

New version of the GitHub App which reduces bandwidth to github for large repositories by only downloading the spaces or pages listed
Supports better comparaison of XML files even if formatting is different (when generated by mvn xar:format for instance)
Added GitHub Descriptor
Added Translations object for automatic discovery
Supports saving GitHub Descriptor and removing user/pass objects from descriptors before committing
Supports committing only a specific list of files
Fix but with UTF encoding

For installation the httpclient libraries are not needed anymore. Only the gson and eclipse libraries are needed in WEB-INF/lib

Available as a XAR file and through manual install of the attached jars.

v1.1

New version of the GitHub App with support for newly created repositories and also for wiki pages stored in a subdirectory of the respository.

With this version the "src/main/resources" maven repository is hardcoded in the Application. You should leave the repository path empty unless you have an additional subdirectory in front of src/main/resources

Available as a XAR file and through manual install of the attached jars.

v1.0

First version. Available as a XAR file and through manual install of the attached jars.

Dependencies

  • org.eclipse.mylyn.github:org.eclipse.egit.github.core 2.1.5
Tags:
Created by Ludovic Dubost on 2014/09/09 00:28
    

Get Connected