Skip to content

Commit

Permalink
Switch to the Maven build system and use exist-apps-parent
Browse files Browse the repository at this point in the history
  • Loading branch information
adamretter committed Sep 16, 2019
1 parent aae3b60 commit 28f5a08
Show file tree
Hide file tree
Showing 252 changed files with 779 additions and 130 deletions.
9 changes: 4 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
.idea
java/classes
atomic-wiki.iml
resources/tmp
/build
target/

.idea/
*.iml
11 changes: 0 additions & 11 deletions .project

This file was deleted.

504 changes: 504 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

44 changes: 10 additions & 34 deletions Readme.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,22 @@ This version of AtomicWiki is a complete rewrite of the older code base. It is u
Download
--------

You can [https://github.com/wolfgangmm/AtomicWiki/downloads](download) a zip containing a ready-to-install application
You can [https://github.com/exist-db/AtomicWiki/downloads](download) a zip containing a ready-to-install application
package plus additional libraries required by eXist. Unzip the downloaded archive and proceed with installing jars.

Installing jars
---------------
You need to copy two .jar files into your eXist-db installation:

* WikiModelV2.jar
* atomicwiki-0.1.jar
## Compilation

Copy them to
* Requirements: Java 8, Apache Maven 3.3+, Git.

EXIST_HOME/lib/user
If you want to create an EXPath Package for the app, you can run:

```bash
$ mvn package
```

There will be a `.xar` file in the `target/` sub-folder.

You'll need to restart eXist-db afterwards so it can pick up the jars. This only needs to be done **once**.

Uploading the package
---------------------
Expand All @@ -52,29 +53,4 @@ file for upload, then click "Upload Package". After installation has finished, y
inside the database) should be accessible at:

http://localhost:8080/exist/apps/wiki/

Building
--------

AtomicWiki is distributed as a .xar package which can be deployed into an existing eXist-db instance through eXist's
application repository.

To build AtomicWiki from scratch,
you should first get eXist-db from SVN and build it (build.sh/build.bat). Next, clone eXide into a directory, e.g.:

git clone git://github.com/wolfgangmm/AtomicWiki.git AtomicWiki
cd AtomicWiki
git submodule update --init --recursive

Edit the file build.properties and change the property exist.dir to point to the root of your eXist installation (eXist-db > 2.0). This is required to compile the Java modules for parsing wiki markup.

Next, call ant on the build.xml file in AtomicWiki:

ant

You should now find a .xar and a .jar file in the build directory:

* build/atomicwiki-0.1.xar
* build/atomicwiki-0.1.jar

Install the jar plus any jar found in java/lib into eXist as described above, then upload the .xar package.
2 changes: 0 additions & 2 deletions build.properties

This file was deleted.

40 changes: 0 additions & 40 deletions build.xml

This file was deleted.

6 changes: 0 additions & 6 deletions expath-pkg.xml

This file was deleted.

3 changes: 0 additions & 3 deletions indexes/README.txt

This file was deleted.

10 changes: 0 additions & 10 deletions indexes/collection.xconf

This file was deleted.

199 changes: 199 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,199 @@
<?xml version="1.0"?>
<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">

<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.exist-db</groupId>
<artifactId>exist-apps-parent</artifactId>
<version>1.8</version>
<relativePath/>
</parent>

<groupId>org.exist-db</groupId>
<artifactId>atomic-wiki</artifactId>
<version>0.9.0-SNAPSHOT</version>

<name>AtomicWiki</name>
<description>Wiki application for eXist-db</description>
<url>http://atomic.exist-db.org</url>

<organization>
<name>eXist-db</name>
<url>http://exist-db.org</url>
</organization>

<licenses>
<license>
<name>GNU Lesser General Public License, version 2.1</name>
<url>http://opensource.org/licenses/LGPL-2.1</url>
<distribution>repo</distribution>
</license>
</licenses>

<scm>
<url>https://github.com/exist-db/atomicwiki.git</url>
<connection>scm:git:https://github.com/exist-db/atomicwiki.git</connection>
<developerConnection>scm:git:https://github.com/exist-db/atomicwiki.git</developerConnection>
</scm>

<issueManagement>
<system>GitHub</system>
<url>https://www.github.com/exist-db/atomicwiki/issues</url>
</issueManagement>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.build.source>1.8</project.build.source>
<project.build.target>1.8</project.build.target>

<exist.version>5.0.0</exist.version>

<!-- used in the EXPath Package Descriptor -->
<package-name>http://exist-db.org/apps/wiki</package-name>
</properties>

<dependencies>
<dependency>
<groupId>org.exist-db</groupId>
<artifactId>exist-core</artifactId>
<version>${exist.version}</version>
</dependency>

<!-- test dependencies -->
<dependency>
<groupId>org.exist-db</groupId>
<artifactId>exist-testkit</artifactId>
<version>${exist.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.xmlunit</groupId>
<artifactId>xmlunit-core</artifactId>
<version>2.4.0</version>
<scope>test</scope>
</dependency>

</dependencies>

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-changes-plugin</artifactId>
<configuration>
<includeOpenIssues>false</includeOpenIssues>
<onlyMilestoneIssues>false</onlyMilestoneIssues>
<columnNames>Type, Summary</columnNames>
<outputDirectory>${project.basedir}</outputDirectory>
</configuration>
<reportSets>
<reportSet>
<reports>
<report>github-report</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>

<build>
<resources>
<resource>
<directory>src/main/xar-resources</directory>
<filtering>true</filtering>
<includes>
<include>templates/**</include>
</includes>
</resource>
<resource>
<directory>src/main/xar-resources</directory>
<filtering>false</filtering>
<excludes>
<exclude>templates/**</exclude>
</excludes>
</resource>
</resources>

<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.0.2</version>
<configuration>
<archive>
<manifest>
<addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
</manifest>
<manifestEntries>
<Build-Tag>${build-tag}</Build-Tag>
<Git-Commit>${build-commit}</Git-Commit>
<Git-Commit-Abbrev>${build-commit-abbrev}</Git-Commit-Abbrev>
<Build-Version>${build-version}</Build-Version>
<Build-Timestamp>${build-tstamp}</Build-Timestamp>
<Source-Repository>${project.scm.connection}</Source-Repository>
<Description>${project.description}</Description>
<Implementation-URL>${project.url}</Implementation-URL>
</manifestEntries>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>ro.kuberam.maven.plugins</groupId>
<artifactId>kuberam-expath-plugin</artifactId>
<executions>
<execution>
<id>create-xar</id>
<phase>package</phase>
<goals>
<goal>make-xar</goal>
</goals>
<configuration>
<descriptor>xar-assembly.xml</descriptor>
<finalName>${package-final-name}</finalName>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<configuration>
<useAgent>true</useAgent>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<configuration>
<mavenExecutorId>forked-path
</mavenExecutorId> <!-- avoid a bug with GPG plugin hanging http://jira.codehaus.org/browse/MGPG-9 -->
<autoVersionSubmodules>true</autoVersionSubmodules>
<tagNameFormat>@{project.version}</tagNameFormat>
</configuration>
</plugin>
</plugins>
</build>

<repositories>
<repository>
<id>exist</id>
<url>http://repo.exist-db.org/repository/exist-db</url>
</repository>
</repositories>

<pluginRepositories>
<pluginRepository>
<id>clojars.org</id>
<url>http://clojars.org/repo</url>
</pluginRepository>
</pluginRepositories>
</project>
19 changes: 0 additions & 19 deletions repo.xml

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 28f5a08

Please sign in to comment.