Wiki source code of XWiki Contrib

Version 27.1 by Vincent Massol on 2013/03/06 15:07

Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 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.
6
7 = Contrib Project List =
8
9 The full list projects is available on the [[##xwiki-contrib## user on GitHub>>https://github.com/organizations/xwiki-contrib]].
10
11 |=Project Name|=What is it?
12 |[[Curriki>>http://www.curriki.org]]|Open Source Curriculum Sharing and Editing based on the XWiki Platform.
13
14 = Hosting tools =
15
16 The project hosting forge can provide contributors with some or all of the following tools :
17
18 * A **GitHub repository**, under http://github.com/xwiki-contrib
19 * 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
20 * A generic **maven groupId**: ##org.xwiki.contrib.<module name>## (until the project reaches a certain size and visibility, in which case it can have its own maven group id). For example: ##org.xwiki.contrib.mailarchive##.
21 * **Project pages** on extensions.xwiki.org to describe and document the project. When the project reaches a certain visibility and size it can have its own wiki on xwiki.org.
22
23 = Requesting a project =
24
25 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 extensions.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 GitHub access, you will need to register a user on http://github.com and let us know about it (a best practice is to have a username 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).
26
27 = Requesting snapshost builds for your project =
28
29 XWiki.org has a [[continuous build>>http://dev.xwiki.org/xwiki/bin/view/Community/ContinuousBuild]] which builds maven projects each time they are modified on GitHub and put the resulting artifact in our [[snapshots repository>>http://maven.xwiki.org/snapshots/]]. This is useful when you want people using your project as a dependency to continuously benefit from the improvements.
30
31 Your can ask for your project to be added to the continuous build:
32
33 * First you need to use the xwiki parent pom to have the correct distribution management information:(((
34 {{code language="xml"}}
35 <project>
36 ...
37 <parent>
38 <groupId>org.xwiki.commons</groupId>
39 <artifactId>xwiki-commons-pom</artifactId>
40 <version>See https://github.com/xwiki/xwiki-commons/blob/master/pom.xml</version>
41 </parent>
42 ...
43 </project>
44 {{/code}}
45 )))
46 * Send a [[vote>>http://dev.xwiki.org/xwiki/bin/view/Community/Committership#HVoting]] on the [email protected] mailing list to discuss the addition of your project in the continuous build(((
47 {{code language="none"}}
48 [VOTE] Add myproject to the continuous build
49
50 Hi XWikiers,
51
52 I'm working on myproject and since it's used as a
53 dependency by someotherproject it'd be convenient
54 if it was built continuously.
55
56 Here's my +1.
57
58 Thanks,
59 Me.
60 {{/code}}
61 )))
62
63 = Release the project =
64
65 XWiki.org allows you to release your project on its maven repository as long as you follow the following steps:
66
67 * Use org.xwiki.contrib as groupId in your maven module
68 * Request for an account on http://nexus.xwiki.org on [email protected]
69 * Once you've received your credentials put them in ~~/.m2/settings.xml(((
70 {{code language="xml"}}
71 <settings>
72 ...
73 <servers>
74 ...
75 <server>
76 <id>xwiki-staging</id>
77 <username>username</username>
78 <password>********</password>
79 </server>
80 ...
81 </servers>
82 ...
83 </settings>
84 {{/code}}
85 )))
86 * Put the following configuration in your project pom.xml(((
87 {{code language="xml"}}
88 <project>
89 ...
90 <scm>
91 <connection>scm:git:git://github.com/xwiki-contrib/{extensionrepository}.git</connection>
92 <developerConnection>scm:git:[email protected]:xwiki-contrib/{extensionrepository}.git</developerConnection>
93 <url>https://github.com/xwiki-contrib/{extensionrepository}</url>
94 </scm>
95 ...
96 <distributionManagement>
97 <repository>
98 <id>xwiki-staging</id>
99 <name>XWiki Staging Repository</name>
100 <url>http://nexus.xwiki.org/nexus/service/local/staging/deploy/maven2/</url>
101 </repository>
102 </distributionManagement>
103 ...
104 </project>
105 {{/code}}
106
107 Where ##{extensionrepository}## is the name of the repository in [[http://github.com/xwiki-contrib/>>http://github.com/xwiki-contrib/]].
108 )))
109 * Release the project with the maven release plugin(((
110 {{code language="none"}}
111 mvn release:prepare
112 mvn release:perform
113 {{/code}}
114 )))
115 * Ask for someone to promote your release (ie. make it available on maven.xwiki.org) in the thread you've created earlier
116 * 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
117
118 = Publishing on extensions.xwiki.org =
119
120 The first step is to [[release>>||anchor="HReleasetheproject"]] your extension in the XWiki Maven Remote Repository. Then go the [[Extension wiki home page>>extensions:Main.WebHome]] and click on the [[Import>>extensions:ExtensionCode.ImportExtension]] button located inside the Contribute box (you'll need to be logged in). Then fill in your extension id (the format is ##<maven groupId>:<maven artifactId>##), select the ##maven-xwiki## repository and press the import button.
121
122 If you have already created an extension page manually on extensions.xwiki.org, the import will locate it (provided you've filled the correct extension id in your extension page, you can edit it in Object mode to fill it if that's not the case) and will overwrite data that it finds in your extension's ##pom.xml## file, preserving the rest of the information you've manually entered (like the description).
123
124 = Implementing your Maven build =
125
126 Here's an example of how your ##pom.xml## should look like (adapt to your need) if you're contributing an application (XAR):
127
128 {{code language="xml"}}
129 <?xml version="1.0" encoding="UTF-8"?>
130
131 <!--
132 *
133 * See the NOTICE file distributed with this work for additional
134 * information regarding copyright ownership.
135 *
136 * This is free software; you can redistribute it and/or modify it
137 * under the terms of the GNU Lesser General Public License as
138 * published by the Free Software Foundation; either version 2.1 of
139 * the License, or (at your option) any later version.
140 *
141 * This software is distributed in the hope that it will be useful,
142 * but WITHOUT ANY WARRANTY; without even the implied warranty of
143 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
144 * Lesser General Public License for more details.
145 *
146 * You should have received a copy of the GNU Lesser General Public
147 * License along with this software; if not, write to the Free
148 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
149 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
150 *
151 -->
152
153 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
154 <modelVersion>4.0.0</modelVersion>
155 <parent>
156 <groupId>org.xwiki.commons</groupId>
157 <artifactId>xwiki-commons-pom</artifactId>
158 <version>4.5</version>
159 </parent>
160 <groupId>org.xwiki.contrib</groupId>
161 <artifactId>your-extension-id</artifactId>
162 <version>1.0-SNAPSHOT</version>
163 <name>Your extension's name</name>
164 <packaging>xar</packaging>
165 <description>Your extension's description</description>
166 <scm>
167 <connection>scm:git:git://github.com/xwiki-contrib/(your extension id).git</connection>
168 <developerConnection>scm:git:[email protected]:xwiki-contrib/(your extension id).git</developerConnection>
169 <url>https://github.com/xwiki-contrib/(your extension id)</url>
170 </scm>
171 <developers>
172 <developer>
173 <id>id of developer 1</id>
174 <name>Full Name of developer 1 as registered on xwiki.org, e.g. Vincent Massol</name>
175 </developer>
176 ...
177 <developer>
178 <id>id of developer N</id>
179 <name>Full Name of developer N as registered on xwiki.org, e.g. Vincent Massol</name>
180 </developer>
181 </developers>
182 <properties>
183 <!-- Don't run CLIRR here since there's no Java code. -->
184 <xwiki.clirr.skip>true</xwiki.clirr.skip>
185 </properties>
186 <build>
187 <!-- Needed to add support for the XAR packaging -->
188 <extensions>
189 <extension>
190 <groupId>org.xwiki.commons</groupId>
191 <artifactId>xwiki-commons-tool-xar-handlers</artifactId>
192 <version>${commons.version}</version>
193 </extension>
194 </extensions>
195 <plugins>
196 <!-- The XAR packaging uses the XAR plugin and thus we need to define what version to use -->
197 <plugin>
198 <groupId>org.xwiki.commons</groupId>
199 <artifactId>xwiki-commons-tool-xar-plugin</artifactId>
200 <version>${commons.version}</version>
201 </plugin>
202 </plugins>
203 </build>
204 </project>
205 {{/code}}
206
207 It's very important that you set the following information as they'll be used when you publish your extension on [[extensions.xwiki.org>>extensions:Main.WebHome]]:
208 * Extension id
209 * Name
210 * Description
211 * Developers
212
213 You'll also need to set the SCM information since using the Maven Release plugin will require those to be set.

Get Connected