Attach sources to fat jar to improve no-build IDE experience (#892)

onthegomap · May 23, 2024 · 3680df6 · 3680df6
1 parent f4fcb16
commit 3680df6
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 33 deletions.
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -57,10 +57,10 @@ jobs:
     # Skip spotless since that gets checked in a separate task
     - name: Build with mvnw (linux/mac)
       if: ${{ !contains(matrix.os, 'windows') }}
-      run: ./mvnw ${{matrix.args}} -Dspotless.check.skip --batch-mode -no-transfer-progress package verify jib:buildTar --file pom.xml
+      run: ./mvnw ${{matrix.args}} -Dspotless.check.skip --batch-mode -no-transfer-progress verify jib:buildTar --file pom.xml
     - name: Build with mvnw.cmd (windows)
       if: ${{ contains(matrix.os, 'windows') }}
-      run: mvnw.cmd ${{matrix.args}} -Dspotless.check.skip --batch-mode -no-transfer-progress package verify jib:buildTar --file pom.xml
+      run: mvnw.cmd ${{matrix.args}} -Dspotless.check.skip --batch-mode -no-transfer-progress verify jib:buildTar --file pom.xml
       shell: cmd
 
   examples:

diff --git a/planetiler-core/pom.xml b/planetiler-core/pom.xml
@@ -47,7 +47,7 @@
     <dependency>
       <groupId>org.locationtech.jts</groupId>
       <artifactId>jts-core</artifactId>
-      <version>1.19.0</version>
+      <version>${jts.version}</version>
     </dependency>
     <dependency>
       <groupId>org.tukaani</groupId>

diff --git a/...etiler-core/src/main/java/com/onthegomap/planetiler/util/SeekableInMemoryByteChannel.java b/...etiler-core/src/main/java/com/onthegomap/planetiler/util/SeekableInMemoryByteChannel.java
@@ -24,6 +24,7 @@
 import java.nio.channels.SeekableByteChannel;
 import java.util.Arrays;
 import java.util.concurrent.atomic.AtomicBoolean;
+import javax.annotation.concurrent.NotThreadSafe;
 
 /**
  * A {@link SeekableByteChannel} implementation that wraps a byte[].
@@ -38,8 +39,8 @@
  * </p>
  *
  * @since 1.13
- * @NotThreadSafe
  */
+@NotThreadSafe
 public class SeekableInMemoryByteChannel implements SeekableByteChannel {
 
   private static final int NAIVE_RESIZE_LIMIT = Integer.MAX_VALUE >> 1;

diff --git a/planetiler-dist/pom.xml b/planetiler-dist/pom.xml
@@ -48,6 +48,19 @@
       <artifactId>planetiler-examples</artifactId>
       <version>${project.parent.version}</version>
     </dependency>
+    <!-- Add sources to the jar to improve IDE experience when using jar with deps -->
+    <dependency>
+      <groupId>com.onthegomap.planetiler</groupId>
+      <artifactId>planetiler-core</artifactId>
+      <version>${project.parent.version}</version>
+      <classifier>sources</classifier>
+    </dependency>
+    <dependency>
+      <groupId>org.locationtech.jts</groupId>
+      <artifactId>jts-core</artifactId>
+      <version>${jts.version}</version>
+      <classifier>sources</classifier>
+    </dependency>
   </dependencies>
 
   <build>

diff --git a/pom.xml b/pom.xml
@@ -22,6 +22,7 @@
     <maven.source.excludeResources>true</maven.source.excludeResources>
     <jackson.version>2.17.1</jackson.version>
     <junit.version>5.10.2</junit.version>
+    <jts.version>1.19.0</jts.version>
     <sonar.host.url>https://sonarcloud.io</sonar.host.url>
     <sonar.organization>onthegomap</sonar.organization>
     <sonar.projectKey>onthegomap_planetiler</sonar.projectKey>
@@ -262,6 +263,21 @@
           </compilerArgs>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-source-plugin</artifactId>
+        <version>3.3.1</version>
+        <executions>
+          <execution>
+            <id>attach-sources</id>
+            <phase>package</phase>
+            <goals>
+              <goal>jar-no-fork</goal>
+              <goal>test-jar-no-fork</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
 
     <pluginManagement>
@@ -309,22 +325,6 @@
             </execution>
           </executions>
         </plugin>
-
-        <plugin>
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-source-plugin</artifactId>
-          <version>3.3.1</version>
-          <executions>
-            <execution>
-              <id>attach-sources</id>
-              <phase>package</phase>
-              <goals>
-                <goal>jar-no-fork</goal>
-                <goal>test-jar-no-fork</goal>
-              </goals>
-            </execution>
-          </executions>
-        </plugin>
         <plugin>
           <groupId>org.sonarsource.scanner.maven</groupId>
           <artifactId>sonar-maven-plugin</artifactId>
@@ -405,19 +405,6 @@
               </execution>
             </executions>
           </plugin>
-          <plugin>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-source-plugin</artifactId>
-            <executions>
-              <execution>
-                <id>attach-sources</id>
-                <goals>
-                  <goal>jar-no-fork</goal>
-                  <goal>test-jar-no-fork</goal>
-                </goals>
-              </execution>
-            </executions>
-          </plugin>
         </plugins>
       </build>
     </profile>