Skip to content

Commit f2bb6e4

Browse files
adamretteradamretter
committed
[feature] Switch to using a Maven build to make things easier
1 parent 044adbf commit f2bb6e4

File tree

211 files changed

+869
-98
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

211 files changed

+869
-98
lines changed

‎.gitignore

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
build/
2-
expath-pkg.xml
1+
target/
2+
*.iml
3+
.idea/
34
*.xpr
4-
local.build.properties

‎GPL2.1-template.txt

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
${project.name}
2+
${project.description}
3+
Copyright (C) ${project.inceptionYear} ${organization}
4+
5+
This library is free software; you can redistribute it and/or
6+
modify it under the terms of the GNU Lesser General Public
7+
License as published by the Free Software Foundation; either
8+
version 2.1 of the License, or (at your option) any later version.
9+
10+
This library is distributed in the hope that it will be useful,
11+
but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13+
Lesser General Public License for more details.
14+
15+
You should have received a copy of the GNU Lesser General Public
16+
License along with this library; if not, write to the Free Software
17+
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

‎LICENSE

+504
Large diffs are not rendered by default.

‎README.md

+33-5
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,38 @@ This repository contains the official documentation for the eXist-db Native XML
1111

1212
## Building from source
1313

14-
- Dependencies: Apache Ant, eXist 2.2+
15-
- Clone the repository to your system
16-
- From the command line, call `ant`
17-
- An EXPath Application Package (.xar file) is deposited in the `build` directory
18-
- Install this file via the Dashboard > Package Manager.
14+
1. Dependencies: Maven 3.x
15+
16+
2. Clone the repository to your system:
17+
18+
```bash
19+
$ git clone https://github.com/exist-db/documentation.git exist-documentation
20+
```
21+
22+
3. Build the documentation application:
23+
```bash
24+
$ cd exist-documentation
25+
$ mvn clean package
26+
```
27+
28+
4. An EXPath Application Package (.xar file) is deposited in the `target` directory
29+
30+
5. Install this file via the Dashboard > Package Manager.
1931

2032
Find an area of the documentation that needs to be improved? Please raise an issue and submit a pull request!
33+
34+
35+
## Building a Release from source
36+
37+
1. Follow the instructions from [Building from source](#building-from-source)
38+
39+
2. Create a Release:
40+
41+
```bash
42+
$ mvn release:prepare
43+
$ mvn release:perform
44+
```
45+
46+
3. An EXPath Application Package (.xar file) is deposited in the `target` directory
47+
48+
4. If you are a core contributor, you should then commit and push.

‎build.properties

-7
This file was deleted.

‎build.xml

-44
This file was deleted.

‎expath-pkg.xml.tmpl

-5
This file was deleted.

‎pom.xml

+238
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,238 @@
1+
<?xml version="1.0"?>
2+
<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/xsd/maven-4.0.0.xsd">
3+
4+
<modelVersion>4.0.0</modelVersion>
5+
6+
<parent>
7+
<groupId>org.sonatype.oss</groupId>
8+
<artifactId>oss-parent</artifactId>
9+
<version>7</version>
10+
<relativePath />
11+
</parent>
12+
13+
<groupId>org.exist-db</groupId>
14+
<artifactId>exist-documentation</artifactId>
15+
<version>0.6.0-SNAPSHOT</version>
16+
17+
<name>eXist-db Documentation</name>
18+
<description>Documentation package for eXist-db</description>
19+
<url>https://www.github.com/exist-db/documentation</url>
20+
<inceptionYear>2001</inceptionYear>
21+
22+
<organization>
23+
<name>eXist-db</name>
24+
<url>http://exist-db.org</url>
25+
</organization>
26+
27+
<licenses>
28+
<license>
29+
<name>GNU Lesser General Public License, version 2.1</name>
30+
<url>http://opensource.org/licenses/LGPL-2.1</url>
31+
<distribution>repo</distribution>
32+
</license>
33+
</licenses>
34+
35+
<scm>
36+
<connection>scm:git:https://www.github.com/exist-db/documentation.git</connection>
37+
<developerConnection>scm:git:https://www.github.com/exist-db/documentation.git</developerConnection>
38+
<url>scm:git:https://www.github.com/exist-db/documentation.git</url>
39+
<tag>HEAD</tag>
40+
</scm>
41+
42+
<properties>
43+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
44+
<project.build.source>1.8</project.build.source>
45+
<project.build.target>1.8</project.build.target>
46+
47+
<exist.version>3.5.0</exist.version>
48+
49+
<package-title>${project.name}</package-title>
50+
<package-name>http://exist-db.org/apps/doc</package-name>
51+
<package-abbrev>${project.artifactId}</package-abbrev>
52+
<package-final-name>${project.artifactId}-${project.version}</package-final-name>
53+
</properties>
54+
55+
<dependencies>
56+
<dependency>
57+
<groupId>org.exist-db</groupId>
58+
<artifactId>exist-testkit</artifactId>
59+
<version>${exist.version}</version>
60+
<scope>test</scope>
61+
</dependency>
62+
<dependency>
63+
<groupId>junit</groupId>
64+
<artifactId>junit</artifactId>
65+
<version>4.12</version>
66+
<scope>test</scope>
67+
</dependency>
68+
</dependencies>
69+
70+
<build>
71+
<plugins>
72+
<plugin>
73+
<groupId>com.mycila</groupId>
74+
<artifactId>license-maven-plugin</artifactId>
75+
<version>3.0</version>
76+
<configuration>
77+
<header>GPL2.1-template.txt</header>
78+
<failIfMissing>true</failIfMissing>
79+
<aggregate>true</aggregate>
80+
<strictCheck>true</strictCheck>
81+
<properties>
82+
<owner>${project.organization.name}</owner>
83+
<organisation>${project.organization.name}</organisation>
84+
<email>[email protected]</email>
85+
<url>${project.organization.url}</url>
86+
</properties>
87+
<headerDefinitions>
88+
<headerDefinition>xquery-license-style.xml</headerDefinition>
89+
</headerDefinitions>
90+
<mapping>
91+
<xq>xquery_style</xq>
92+
<xqm>xquery_style</xqm>
93+
</mapping>
94+
<excludes>
95+
<exclude>pom.xml</exclude>
96+
<exclude>README.md</exclude>
97+
<exclude>LICENSE</exclude>
98+
<exclude>xquery-license-style.xml</exclude>
99+
<exclude>xar-assembly.xml</exclude>
100+
</excludes>
101+
</configuration>
102+
</plugin>
103+
<plugin>
104+
<groupId>org.apache.maven.plugins</groupId>
105+
<artifactId>maven-compiler-plugin</artifactId>
106+
<version>3.6.1</version>
107+
<configuration>
108+
<source>${project.build.source}</source>
109+
<target>${project.build.target}</target>
110+
<encoding>${project.build.sourceEncoding}</encoding>
111+
</configuration>
112+
<executions>
113+
<execution>
114+
<phase>compile</phase>
115+
<goals>
116+
<goal>compile</goal>
117+
</goals>
118+
</execution>
119+
</executions>
120+
</plugin>
121+
<plugin>
122+
<groupId>com.code54.mojo</groupId>
123+
<artifactId>buildversion-plugin</artifactId>
124+
<version>1.0.3</version>
125+
<executions>
126+
<execution>
127+
<phase>validate</phase>
128+
<goals>
129+
<goal>set-properties</goal>
130+
</goals>
131+
</execution>
132+
</executions>
133+
</plugin>
134+
<plugin>
135+
<groupId>org.apache.maven.plugins</groupId>
136+
<artifactId>maven-jar-plugin</artifactId>
137+
<version>3.0.2</version>
138+
<configuration>
139+
<archive>
140+
<manifestEntries>
141+
<Build-Tag>${build-tag}</Build-Tag>
142+
<Git-Commit>${build-commit}</Git-Commit>
143+
<Git-Commit-Abbrev>${build-commit-abbrev}</Git-Commit-Abbrev>
144+
<Build-Version>${build-version}</Build-Version>
145+
<Build-Timestamp>${build-tstamp}</Build-Timestamp>
146+
<Source-Repository>${project.scm.connection}</Source-Repository>
147+
<Description>${project.description}</Description>
148+
<Implementation-URL>${project.url}</Implementation-URL>
149+
</manifestEntries>
150+
</archive>
151+
</configuration>
152+
</plugin>
153+
<plugin>
154+
<groupId>ro.kuberam.maven.plugins</groupId>
155+
<artifactId>kuberam-expath-plugin</artifactId>
156+
<version>0.4.9</version>
157+
<executions>
158+
<execution>
159+
<id>create-xar</id>
160+
<phase>package</phase>
161+
<goals>
162+
<goal>make-xar</goal>
163+
</goals>
164+
<configuration>
165+
<descriptor>xar-assembly.xml</descriptor>
166+
<finalName>${package-final-name}</finalName>
167+
</configuration>
168+
</execution>
169+
</executions>
170+
</plugin>
171+
<plugin>
172+
<!-- Attach source jars -->
173+
<groupId>org.apache.maven.plugins</groupId>
174+
<artifactId>maven-source-plugin</artifactId>
175+
<version>3.0.1</version>
176+
<configuration>
177+
<archive>
178+
<manifest>
179+
<addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
180+
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
181+
</manifest>
182+
<manifestEntries>
183+
<Build-Tag>${build-tag}</Build-Tag>
184+
<Git-Commit>${build-commit}</Git-Commit>
185+
<Git-Commit-Abbrev>${build-commit-abbrev}</Git-Commit-Abbrev>
186+
<Build-Version>${build-version}</Build-Version>
187+
<Build-Timestamp>${build-tstamp}</Build-Timestamp>
188+
<Source-Repository>${project.scm.connection}</Source-Repository>
189+
<Description>${project.description}</Description>
190+
<Implementation-URL>${project.url}</Implementation-URL>
191+
</manifestEntries>
192+
</archive>
193+
</configuration>
194+
<executions>
195+
<execution>
196+
<id>attach-sources</id>
197+
<phase>verify</phase>
198+
<goals>
199+
<goal>jar</goal>
200+
</goals>
201+
</execution>
202+
</executions>
203+
</plugin>
204+
<plugin>
205+
<groupId>org.apache.maven.plugins</groupId>
206+
<artifactId>maven-gpg-plugin</artifactId>
207+
<version>1.6</version>
208+
<configuration>
209+
<useAgent>true</useAgent>
210+
</configuration>
211+
</plugin>
212+
<plugin>
213+
<groupId>org.apache.maven.plugins</groupId>
214+
<artifactId>maven-release-plugin</artifactId>
215+
<version>2.5.3</version>
216+
<configuration>
217+
<mavenExecutorId>forked-path</mavenExecutorId> <!-- avoid a bug with GPG plugin hanging http://jira.codehaus.org/browse/MGPG-9 -->
218+
<autoVersionSubmodules>true</autoVersionSubmodules>
219+
<tagNameFormat>@{project.version}</tagNameFormat>
220+
</configuration>
221+
</plugin>
222+
</plugins>
223+
</build>
224+
225+
<repositories>
226+
<repository>
227+
<id>exist</id>
228+
<url>https://raw.github.com/eXist-db/mvn-repo/master/</url>
229+
</repository>
230+
</repositories>
231+
232+
<pluginRepositories>
233+
<pluginRepository>
234+
<id>clojars.org</id>
235+
<url>http://clojars.org/repo</url>
236+
</pluginRepository>
237+
</pluginRepositories>
238+
</project>

0 commit comments

Comments
 (0)