diff --git a/.gitignore b/.gitignore index 96ade20..604493b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ *.class +*.bak* +*.orig* # Package Files # *.jar @@ -7,6 +9,11 @@ # Maven build workspace # target/ +*.releaseBackup +release.properties # NIT generated configs, if running from workspace root tmp/ + +/.idea/ +/jNut*.tar.gz diff --git a/README.adoc b/README.adoc index 2d301f7..fc3354e 100644 --- a/README.adoc +++ b/README.adoc @@ -8,6 +8,13 @@ The `test-NIT.sh` script can be used to arrange a NUT driver+server setup using the NUT Integration Test suite script (you can find it in the main NUT repository). +For more details about the NUT ecosystem, please see +https://networkupstools.org/ and +https://github.com/networkupstools/nut/ + +Sources of this project can be found at +https://github.com/networkupstools/jNut/ + Java NUT Client files ~~~~~~~~~~~~~~~~~~~~~ diff --git a/jNut/.gitignore b/jNut/.gitignore deleted file mode 100644 index eb5a316..0000000 --- a/jNut/.gitignore +++ /dev/null @@ -1 +0,0 @@ -target diff --git a/jNut/README.adoc b/jNut/README.adoc index dc4f2a3..ea53468 100644 --- a/jNut/README.adoc +++ b/jNut/README.adoc @@ -47,8 +47,8 @@ You can generate jNut javadoc by typing: mvn javadoc:javadoc -Documentation will be generated in the `target/site/apidocs` subdirectory, -and its entry point is located at `target/site/apidocs/index.html`. +Documentation will be generated in the `target/reports/apidocs` subdirectory, +and its entry point is located at `target/reports/apidocs/index.html`. Workspace cleaning ^^^^^^^^^^^^^^^^^^ diff --git a/jNutList/pom.xml b/jNutList/pom.xml index 544560d..d4372a9 100644 --- a/jNutList/pom.xml +++ b/jNutList/pom.xml @@ -30,7 +30,6 @@ org.apache.maven.plugins ...which is assumed by default. --> maven-assembly-plugin - 3.8.0 jar-with-dependencies diff --git a/jNutWebAPI/pom.xml b/jNutWebAPI/pom.xml index efec050..5060a8f 100644 --- a/jNutWebAPI/pom.xml +++ b/jNutWebAPI/pom.xml @@ -53,7 +53,6 @@ org.apache.maven.plugins maven-war-plugin - 3.5.1 false @@ -61,7 +60,6 @@ org.apache.maven.plugins maven-dependency-plugin - 3.10.0 validate diff --git a/make-tarballs.sh b/make-tarballs.sh new file mode 100755 index 0000000..bcad6dd --- /dev/null +++ b/make-tarballs.sh @@ -0,0 +1,39 @@ +#!/bin/sh + +# Helper to create tarballs for NUT-Website publication +set -e +set -u + +POM_VERSION="`mvn -B -q help:evaluate -Dexpression=project.version -DforceStdout`" +echo "${POM_VERSION}" + +rm -rf tmp/tarballs +mkdir -p tmp/tarballs/jNut-"${POM_VERSION}" tmp/tarballs/jNutWebAPI-"${POM_VERSION}" + +MVN_ARGS="-B" +if [ x"$1" = x-f ] ; then + mvn $MVN_ARGS clean + MVN_ARGS="$MVN_ARGS -U" +fi + +mvn $MVN_ARGS package || exit + +# Local dependencies for javadocs stage: +mvn $MVN_ARGS install || exit +mvn $MVN_ARGS javadoc:javadoc || exit + +# Library and sample client go together: +tar cz --exclude target -f tmp/tarballs/jNut-"${POM_VERSION}"/jNut-"${POM_VERSION}"-src.tar.gz jNut +tar cz --exclude target -f tmp/tarballs/jNut-"${POM_VERSION}"/jNutList-"${POM_VERSION}"-src.tar.gz jNutList +cp LICENSE.md README.adoc test-NIT.sh tmp/tarballs/jNut-"${POM_VERSION}"/ +cp jNut/target/*.jar jNutList/target/*.jar tmp/tarballs/jNut-"${POM_VERSION}"/ +cp -r jNut/target/reports/apidocs/ tmp/tarballs/jNut-"${POM_VERSION}"/jNut-apidocs/ +cp -r jNutList/target/reports/apidocs/ tmp/tarballs/jNut-"${POM_VERSION}"/jNutList-apidocs/ + +# REST API is larger and standalone (as an artifact): +tar cz --exclude target -f tmp/tarballs/jNutWebAPI-"${POM_VERSION}"/jNutWebAPI-"${POM_VERSION}"-src.tar.gz jNutWebAPI +cp jNutWebAPI/target/*.war tmp/tarballs/jNutWebAPI-"${POM_VERSION}"/ +cp -r jNutWebAPI/target/reports/apidocs/ tmp/tarballs/jNutWebAPI-"${POM_VERSION}"/jNutWebAPI-apidocs/ + +(cd tmp/tarballs/ && tar czf - jNut-"${POM_VERSION}") > jNut-"${POM_VERSION}".tar.gz +(cd tmp/tarballs/ && tar czf - jNutWebAPI-"${POM_VERSION}") > jNutWebAPI-"${POM_VERSION}".tar.gz diff --git a/pom.xml b/pom.xml index ed80fc0..ac0418a 100644 --- a/pom.xml +++ b/pom.xml @@ -57,6 +57,56 @@ + + org.apache.maven.plugins + maven-clean-plugin + 3.5.0 + + + org.apache.maven.plugins + maven-resources-plugin + 3.5.0 + + + org.apache.maven.plugins + maven-surefire-plugin + 3.5.5 + + + org.apache.maven.plugins + maven-jar-plugin + 3.5.0 + + + org.apache.maven.plugins + maven-install-plugin + 3.1.4 + + + org.apache.maven.plugins + maven-deploy-plugin + 3.1.4 + + + org.apache.maven.plugins + maven-war-plugin + 3.5.1 + + + org.apache.maven.plugins + maven-dependency-plugin + 3.10.0 + + + org.apache.maven.plugins + maven-assembly-plugin + 3.8.0 + + + org.apache.maven.plugins + maven-site-plugin + 3.21.0 +