Skip to content
This repository was archived by the owner on May 7, 2025. It is now read-only.

Produce Maven packages for shared Javascript components #207

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

Produce Maven packages for shared Javascript components #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
021d364
Add a Maven POM definition to package compiled resources into a jar f…
io7m Sep 1, 2015
c289d04
Update README for Maven package
io7m Sep 1, 2015
4b91939
Correct URL
io7m Sep 1, 2015
27a2d55
Clarify deployment
io7m Sep 1, 2015
bb7cb8a
Set POM version to 0.20.0-alpha, and add POM metadata to meet Maven C…
io7m Sep 24, 2015
2059852
Enable optional PGP signing of packages when the readium-sign profile…
io7m Sep 24, 2015
dac53a7
Produce a jar of the JS resources, and an empty "sources" and "javado…
io7m Sep 24, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,3 +202,30 @@ For more complex build processes, Grunt / Gulp can be used, but these build syst

Downside: DO NOT invoke `npm init` or `npm install --save` `--save-dev` `--save-optional`,
as this would overwrite / update the JSON, not the master CSON!

## Maven Package

Once the JS components have been bundled with the `npm build` commands
shown above, a Maven package can be produced containing the relevant
resources. This can then be referenced from Android applications as
a standard library dependency, instead of having to import the sources
directly into the project as a `git submodule`.

To create a package:

```bash
$ mvn clean package
```

After the package has been deployed to a repository with `mvn deploy`,
the package can be referenced from an Android application with (in Maven
dependency syntax):

```
<dependency>
<groupId>org.readium</groupId>
<artifactId>readium-shared-js</artifactId>
<version>0.20.0</version>
</dependency>
```

200 changes: 200 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@
<?xml version="1.0" encoding="UTF-8"?>
<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>
<groupId>org.readium</groupId>
<artifactId>readium-shared-js</artifactId>
<version>0.20.0-alpha</version>

<packaging>jar</packaging>
<description>Readium SDK (Shared JavaScript components)</description>
<url>https://github.com/readium/readium-shared-js</url>

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>

<scm>
<url>https://github.com/readium/readium-shared-js</url>
<connection>scm:https://github.com/readium/readium-shared-js</connection>
<developerConnection>scm:https://github.com/readium/readium-shared-js</developerConnection>
</scm>

<issueManagement>
<url>https://github.com/readium/readium-shared-js/issues</url>
<system>GitHub</system>
</issueManagement>

<distributionManagement>
<site>
<id>GitHub</id>
<name>GitHub</name>
<url>${project.url}</url>
</site>
</distributionManagement>

<licenses>
<license>
<name>3-Clause BSD License</name>
<url>http://opensource.org/licenses/BSD-3-Clause</url>
</license>
</licenses>

<developers>
<developer>
<name>Daniel Weck</name>
<email>[email protected]</email>
<organization>Readium Foundation</organization>
<organizationUrl>http://readium.org/</organizationUrl>
</developer>
<developer>
<name>Mark Raynsford</name>
<email>[email protected]</email>
<roles>
<role>Maven operator</role>
</roles>
</developer>
</developers>

<prerequisites>
<maven>3.2.1</maven>
</prerequisites>

<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>2.6.1</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>2.8.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-install-plugin</artifactId>
<version>2.5.2</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>2.7</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.4</version>
</plugin>

<!-- Produce custom manifest in jar files -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.6</version>
<configuration>
<archive>
<manifestEntries>
<Specification-Title>${project.name}</Specification-Title>
<Specification-Version>${project.version}</Specification-Version>
<Specification-Vendor>Readium Foundation</Specification-Vendor>
<Implementation-Title>${project.name}</Implementation-Title>
<Implementation-Version>${project.version}</Implementation-Version>
<Implementation-Vendor>Readium Foundation</Implementation-Vendor>
<Implementation-Vendor-Id>${project.groupId}</Implementation-Vendor-Id>
<Sealed>true</Sealed>
</manifestEntries>
</archive>
</configuration>
</plugin>
</plugins>
</pluginManagement>

<!-- Pack all resources into the package -->
<resources>
<resource>
<directory>build-output/_single-bundle</directory>
<includes>
<include>readium-shared-js_all.js</include>
<include>readium-shared-js_all.js.bundles.js</include>
<include>readium-shared-js_all.js.map</include>
</includes>
</resource>
<resource>
<directory>build-output/css</directory>
<includes>
<include>sdk.css</include>
</includes>
</resource>
</resources>

<!-- Produce a jar of the JS output, and empty sources and javadoc jars. -->
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<executions>
<execution>
<id>default-jar</id>
<phase>package</phase>
<goals><goal>jar</goal></goals>
</execution>
<execution>
<id>source-jar</id>
<phase>package</phase>
<goals><goal>jar</goal></goals>
<configuration>
<excludes>
<exclude>**/**</exclude>
</excludes>
<classifier>sources</classifier>
</configuration>
</execution>
<execution>
<id>javadoc-jar</id>
<phase>package</phase>
<goals><goal>jar</goal></goals>
<configuration>
<excludes>
<exclude>**/**</exclude>
</excludes>
<classifier>javadoc</classifier>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

<!-- Optionally PGP sign artifacts. -->
<profiles>
<profile>
<id>readium-sign</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.6</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>

</project>