Skip to content

Commit

Permalink
Merge pull request #8 from NASA-PDS-Incubator/dev
Browse files Browse the repository at this point in the history 
Release v1.0.1
  • Loading branch information
@jordanpadams
jordanpadams authored Jun 29, 2019
2 parents 9ea7c92 + 69af3a2 commit 6fb07dd
Show file tree
Hide file tree
Showing 2 changed files with 181 additions and 29 deletions.
85 changes: 65 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,17 @@ Java library providing APIs for parsing and exporting information
on PDS4 table and image objects to various formats including CSV, PNG, Vicar,
Fits, etc. The software is packaged in a JAR file.


# Dependencies
Two dependencies for this tool are not yet in Maven Central repository so they will need to be installed in your local maven repository in order to build and compile.

## PDS3 Product Tools
```1. Clone the repo and checkout v4.0.0:
```
git clone [email protected]:NASA-PDS-Incubator/pds3-product-tools.git
git checkout tags/v4.0.0
```
2. Run `mvn install` to install the package in your local maven repo.
# System Requirements
Current software requires:
* Java 1.8 - the Ant build does not appear to complete succcessfully in later versions of Java
* Maven 2 - EN builds have not yet migrated to Maven 3, so unknown if the software will build correctly

# Documentation
The documentation including release notes, installation and operation of the
software should be online at
https://pds-engineering.jpl.nasa.gov/development/pds4/current/preparation/validate/. If it is not
accessible, you can execute the "mvn site:run" command and view the
documentation locally at http://localhost:8080.

# Build
The software can be compiled and built with the "mvn compile" command but in order
Expand All @@ -28,13 +22,64 @@ to create the JAR file, you must execute the "mvn compile jar:jar" command.
In order to create a complete distribution package, execute the
following commands:

% mvn site
% mvn package
```
mvn site
mvn package
```

# Release
Here is the procedure for releasing the software both in Github and pushing the JARs to the public Maven Central repo.

# Documentation
The documentation including release notes, installation and operation of the
software should be online at
https://pds-engineering.jpl.nasa.gov/development/pds4/current/preparation/validate/. If it is not
accessible, you can execute the "mvn site:run" command and view the
documentation locally at http://localhost:8080.
## Pre-Requisites
* Make sure you have your GPG Key created and sent to server.
* Make sure you have your .settings configured correctly for GPG:
```
<profiles>
<profile>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<gpg.executable>gpg</gpg.executable>
<gpg.keyname>KEY_NAME</gpg.keyname>
<gpg.passphrase>KEY_PASSPHRASE</gpg.passphrase>
</properties>
</profile>
</profiles>
```

## Operational Release
1. Checkout the dev branch.

2. Version the software:
```
mvn versions:set -DnewVersion=1.2.0
```

3. Deploy software to Sonatype Maven repo:
```
# Operational release
mvn clean site deploy -P release
```

4. Create pull request from dev -> master and merge.

5. Tag release in Github

6. Update version to next snapshot:
```
mvn versions:set -DnewVersion=1.3.0-SNAPSHOT
```

## SNAPSHOT Release
1. Checkout the dev branch.

2. Deploy software to Sonatype Maven repo:
```
# Operational release
mvn clean site deploy
```

# Maven JAR Dependency

https://search.maven.org/search?q=g:gov.nasa.pds%20AND%20a:pds4-jparser&core=gav
125 changes: 116 additions & 9 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,36 +32,55 @@
POSSIBILITY OF SUCH DAMAGE.
-->

<project>
<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">
<modelVersion>4.0.0</modelVersion>

<groupId>gov.nasa.pds</groupId>
<artifactId>pds4-jparser</artifactId>
<version>1.0.0</version>
<version>1.0.1</version>
<packaging>jar</packaging>

<name>PDS4 JParser</name>
<name>${project.groupId}:${project.artifactId}</name>
<description>
This is the parser library for the PDS4 planetary data standard.
</description>
<url>https://pds-engineering.jpl.nasa.gov/development/pds4/current/preparation/pds4-jparser/index.html</url>

<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>file:///${basedir}/LICENSE.txt</url>
<distribution>repo</distribution>
<name>The Apache License, Version 2.0</name>
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url>
</license>
</licenses>

<developers>
<developer>
<name>Jordan Padams</name>
<id>jpadams</id>
<email>[email protected]</email>
<organization>NASA Jet Propulsion Laboratory</organization>
<roles>
<role>PDS Engineering Node Manager</role>
</roles>
</developer>
<developer>
<name>Galen Hollins</name>
<id>ghollins</id>
<email>[email protected]</email>
<organization>NASA Jet Propulsion Laboratory</organization>
<roles>
<role>PDS Engineering Node Development Lead</role>
</roles>
</developer>
<developer>
<name>Sean Hardman</name>
<id>shardman</id>
<email>[email protected]</email>
<organization>NASA Jet Propulsion Laboratory</organization>
<roles>
<role>Development Lead</role>
<role>Former Development Lead</role>
</roles>
</developer>
<developer>
Expand All @@ -70,7 +89,7 @@
<email>[email protected]</email>
<organization>NASA Jet Propulsion Laboratory</organization>
<roles>
<role>Developer</role>
<role>Former Developer</role>
</roles>
</developer>
<developer>
Expand Down Expand Up @@ -116,6 +135,17 @@
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.7</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
Expand Down Expand Up @@ -291,6 +321,83 @@
</plugins>
</pluginManagement>
</build>

<distributionManagement>
<snapshotRepository>
<id>ossrh</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</snapshotRepository>
<repository>
<id>ossrh</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>

<scm>
<url>https://github.com/NASA-PDS-Incubator/pds3-product-tools/tree/master</url>
<connection>scm:git:git://github.com/NASA-PDS-Incubator/pds3-product-tools.git</connection>
<developerConnection>scm:git:ssh://github.com:NASA-PDS-Incubator/pds3-product-tools.git</developerConnection>
</scm>

<profiles>
<profile>
<id>release</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<executions>
<execution>
<id>attach-sources</id>
<phase>prepare-package</phase>
<goals>
<goal>jar-no-fork</goal>
<goal>test-jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<source>1.8</source>
<failOnError>false</failOnError>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.5</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
<configuration>
<gpgArguments>
<arg>--pinentry-mode</arg>
<arg>loopback</arg>
</gpgArguments>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>

<repositories>
<!-- JBoss Repo Needed for JAI libraries -->
Expand Down Expand Up @@ -459,7 +566,7 @@
<dependency>
<groupId>gov.nasa.pds</groupId>
<artifactId>pds3-product-tools</artifactId>
<version>4.0.0</version>
<version>4.0.1</version>
<scope>test</scope>
</dependency>
<!-- Temporary local lib jars until available on Maven central -->
Expand Down

0 comments on commit 6fb07dd

Please sign in to comment.