The XWiki Contrib Project provides hosting for projects related to XWiki. These projects are not part of the official XWiki distributions and are not maintained by the XWiki development team.

Hosting tools

The project hosting forge can provide contributors with some or all of the following tools :

  • A SVN directory, under http://svn.xwiki.org/svnroot/xwiki/contrib/
  • A JIRA project for tracking bugs and feature requests, at http://jira.xwiki.org/ and under the "XWiki Contributed projects" category. Note that there will be a generic JIRA project to be used by all projects till they  achieve a first release or till they grow to a size significant enough to warrant a dedicated JIRA project
  • A generic maven groupId : org.xwiki.contrib
  • Project pages on xwiki.org sites to describe and document the project.

    Our long term objective is to make all projects documentation accessible from http://code.xwiki.org, though the content from code.xwiki.org should be aggregated from the various XWiki sites : platform.xwiki.org for the XWiki platform's modules, contrib.xwiki.org for contributed projects, etc.

    For the time being and until we perform that restructuration of code.xwiki.org, projects from the XWiki Contrib project can be documented in two places : 

    • On a page on code.xwiki.org, only if the project has been already made available for download here (i.e., has been released at least once).
    • On a dedicated space on contrib.xwiki.org for other projects.

Requesting a project

The contrib project is open for anyone with a project that request it. Simply send us an email at devs AT xwiki.org using "[Contrib]" at the beginning of your email's subject. Let us know the name and a short description of your project. If your project has already been made available for download on code.xwiki.org, please precise it and point us to its page (If it is not, then no need to hurry, you will make it available once it's ready). Finally, let us know which of the listed tools you need. For SVN access, you will need to register a user on http://www.xwiki.org with a UNIX-like user name, and let us know about it. Such a username is composed of the first letter of your first name immediately followed by your last name, the whole with no capital letter (for example jdoe if your name is John Doe). We will get back to you shortly with all the information you need.

SVN organization

The contrib SVN directory (in XWiki's SVN repository) is organized with the following structure :

  http://svn.xwiki.org/svnroot/xwiki/contrib/ |__people/ |__projects/ |__retired/ |__sandbox/  

Each of the sub-directory has the following meaning :

  • people is a directory for "personal tests" projects. The idea is behind is to give whoever requests it a personal space where he can experiment with XWiki code, and that space is private (i.e. an implied rule is that people are not supposed to commit code in others projects, thus making it different from sandbox projects). Each sub-folder of people/ is composed of the username of the person that requests his project, for example "jvelociter".
  • projects hosts the actual contrib projects, that are active (meaning that they still do make sense as projects in
    the XWiki ecosystem, they are not abandoned, etc.)
  • retired is the "place where dead project go ;(" A dead project can be a project that get superseded by a newer one, or a project that is not actively maintained for a long period of time.
  • sandbox is the place for experimental projects that have not been released.

Requesting snapshost builds for your project

XWiki.org has a continuous build which builds maven projects each time they are modified on the SVN and put the resulting artifact in our snapshots repository. This is useful when you want people using your project as a dependency to continuously benefit from the improvements.

Your can ask for your project to be added to the continuous build:

  • First you need to use the xwiki parent pom to have the correct distribution management information:
    <project>
    ...
      <parent>
        <groupId>org.xwiki.platform</groupId>
        <artifactId>xwiki</artifactId>
        <version>See https://svn.xwiki.org/svnroot/xwiki/platform/pom/trunk/pom.xml</version>
      </parent>
    ...
    </project>
  • Send a vote on the [email protected] mailing list to discuss the addition of your project in the continuous build
    [VOTE] Add myproject to the continuous build

    Hi XWikiers,

    I'm working on myproject and since it's used as a
    dependency by someotherproject it'd be convenient
    if it was built continuously.

    Here's my +1.

    Thanks,
    Me.

Promoting a project out of the sandbox

  • Send a vote on the [email protected] mailing list to discuss the promotion of your project out of sandbox
    [VOTE] Move myproject out of sandbox and release myproject 1.0

    Hi XWikiers,

    I've been working on myproject for a while now and I think it is
    stable enough to be moved out of sandbox and for a 1.0 version to
    be released.

    Here's my +1.

    Thanks,
    Me.
  • If the vote pass create an issue on http://jira.xwiki.org/jira/browse/XCONTRIB regarding your project promotion
  • Create the new home for your project in contrib/projects/ and move it there
    cd contrib/projects
    mkdir myproject
    mkdir myproject/branches
    mkdir myproject/tags
    svn add myproject
    cd ../sandbox
    svn move myproject ../projects/myproject/trunk
    cd ../../
    svn ci (don't forget to refer to the JIRA issue you've created)

Release the project

XWiki.org allows you to release your project on its maven repository as long as you follow the following steps:

  • Use org.xwiki.contrib as groupId in your maven module
  • Request for an account on http://nexus.xwiki.org on [email protected]
  • Once you've received your credentials put them in ~/.m2/settings.xml
    <settings>
    ...
    <servers>
    ...
     <server>
       <id>xwiki-staging</id>
       <username>username</username>
       <password>********</password>
     </server>
    ...
    </servers>
    ...
    </settings>
  • Put the following configuration in your project pom.xml
    <project>
    ...
     <distributionManagement>
       <repository>
         <id>xwiki-staging</id>
         <name>XWiki Staging Repository</name>
         <url>http://nexus.xwiki.org/nexus/service/local/staging/deploy/maven2/</url>
       </repository>
     </distributionManagement>
    ...
    </project>
  • Release the project with the maven release plugin
    mvn release:prepare
    mvn release:perform
  • Ask for someone to promote your release (ie. make it available on maven.xwiki.org) in the thread you've created earlier
  • After that your release will be available for download on maven.xwiki.org and anyone will be able to use it as a dependency for his own project
Tags:
   

Get Connected