Use scala-maven-plugin to build javadoc; resolve #4.

- Use scala-maven-plugin to build javadoc so we can release on Maven Central. - Update README for impending release - Update TravisCI config - Remove old maven javadocs and site build plugins
archivesunleashed · Dec 10, 2019 · 3dbeb15c261cf85355f83877f0ac1c4d7d87ab0d · 3dbeb15
1 parent 2ef2c55
commit 3dbeb15c261cf85355f83877f0ac1c4d7d87ab0d
Unified Split

Showing with 17 additions and 65 deletions.

+1 −1 .travis.yml

+4 −4 README.md

+12 −60 pom.xml
diff --git a/.travis.yml b/.travis.yml
@@ -20,7 +20,7 @@ before_install:
 
 script:
  - mvn install -B -V
- - mvn site
+ - mvn javadoc:jar
 
 after_success:
   - bash <(curl -s https://codecov.io/bash)
diff --git a/README.md b/README.md
@@ -21,13 +21,13 @@ An open-source toolkit for analyzing line-oriented JSON Twitter archives with Ap
 #### Spark Shell
 
 ```
-$ spark-shell --packages "io.archivesunleashed:twut:0.0.3"
+$ spark-shell --packages "io.archivesunleashed:twut:0.0.4"
 ```
 
 #### PySpark
 
 ```
-$ pyspark --py-files /path/to/twut.zip --packages "io.archivesunleashed:twut:0.0.3"
+$ pyspark --py-files /path/to/twut.zip --packages "io.archivesunleashed:twut:0.0.4"
 ```
 
 You will need the `PYSPARK_PYTHON` and `PYSPARK_DRIVER_PYTHON` environment variables set.
@@ -39,13 +39,13 @@ You can download the [latest release files here](https://github.com/archivesunle
 #### Spark Shell
 
 ```
-$ spark-shell --jars /path/to/twut-0.0.3-fatjar.jar
+$ spark-shell --jars /path/to/twut-0.0.4-fatjar.jar
 ```
 
 #### PySpark
 
 ```
-$ pyspark --py-files /path/to/twut.zip --driver-class-path /path/to/twut-0.0.3-fatjar.jar --jars /path/to/twut-0.0.3-fatjar.jar
+$ pyspark --py-files /path/to/twut.zip --driver-class-path /path/to/twut-0.0.4-fatjar.jar --jars /path/to/twut-0.0.4-fatjar.jar
 ```
 
 ## Documentation! Or, how do I use this?

diff --git a/pom.xml b/pom.xml
@@ -150,6 +150,18 @@
               <goal>testCompile</goal>
             </goals>
           </execution>
+          <execution>
+            <id>attach-javadocs</id>
+            <goals>
+              <goal>doc-jar</goal>
+            </goals>
+          </execution>
+          <execution>
+            <id>attach-sources</id>
+            <goals>
+              <goal>add-source</goal>
+            </goals>
+          </execution>
         </executions>
         <configuration>
           <scalaVersion>${scala.version}</scalaVersion>
@@ -250,66 +262,6 @@
           </execution>
         </executions>
       </plugin>
-      <!-- So we can release twut. -->
-      <plugin>
-        <artifactId>maven-release-plugin</artifactId>
-        <version>${release.plugin.version}</version>
-        <configuration>
-          <!-- see http://jira.codehaus.org/browse/MRELEASE-424 -->
-          <mavenExecutorId>forked-path</mavenExecutorId>
-        </configuration>
-        <dependencies>
-          <dependency>
-            <groupId>org.apache.maven.scm</groupId>
-            <artifactId>maven-scm-provider-gitexe</artifactId>
-            <version>${scm-provider-gitexe.plugin.version}</version>
-          </dependency>
-        </dependencies>
-      </plugin>
-      <!-- GitHub Pages -->
-      <plugin>
-        <artifactId>maven-deploy-plugin</artifactId>
-        <version>${deploy.plugin.version}</version>
-      </plugin>
-      <plugin>
-        <artifactId>maven-site-plugin</artifactId>
-        <version>${site.plugin.version}</version>
-        <configuration>
-          <skipDeploy>true</skipDeploy>
-        </configuration>
-        <dependencies>
-          <dependency>
-            <!-- Allows markdown syntax for site generation. To use it
-                 place files below src/site/markdown/[filename].md -->
-            <groupId>org.apache.maven.doxia</groupId>
-            <artifactId>doxia-module-markdown</artifactId>
-            <version>${doxia-markdown.plugin.version}</version>
-          </dependency>
-        </dependencies>
-      </plugin>
-      <plugin>
-        <groupId>com.github.github</groupId>
-        <artifactId>site-maven-plugin</artifactId>
-        <version>${github-site.plugin.version}</version>
-        <configuration>
-          <message>Creating site for ${project.artifactId}, ${project.version}</message>
-          <path>${project.distributionManagement.site.url}</path>
-          <merge>true</merge>
-          <excludes>
-            <exclude>xref-test/**</exclude>
-            <exclude>testapidocs/**</exclude>
-          </excludes>
-        </configuration>
-        <executions>
-          <execution>
-            <id>github</id>
-            <goals>
-              <goal>site</goal>
-            </goals>
-            <phase>site-deploy</phase>
-          </execution>
-        </executions>
-      </plugin>
       <plugin>
         <artifactId>maven-changelog-plugin</artifactId>
         <version>${changelog.plugin.version}</version>