configures release pipeline (#105)

.github/workflows/ci.yml

@@ -24,11 +24,24 @@ jobs:
           distribution: 'liberica'
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Compile
-        run: ./mvnw clean compile
+      - name: Build
+        run: ./mvnw --batch-mode clean compile
       - name: Test
-        run: ./mvnw test
-      - name: Integration Test
-        run: ./mvnw verify -DskipUTs=true
-      - name: Install
-        run: ./mvnw install -DskipTests
+        run: ./mvnw --batch-mode verify
+  install:
+    name: Install
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install GPG Secret Key
+        run: cat <(echo -e "${{ secrets.GPG_SECRET_KEY }}") | gpg --batch --import
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install to Local Repository
+        env:
+          CENTRAL_USERNAME_TOKEN: ${{ secrets.CENTRAL_USERNAME_TOKEN }}
+          CENTRAL_PASSWORD_TOKEN: ${{ secrets.CENTRAL_PASSWORD_TOKEN }}
+        run: |
+          maven_args="--batch-mode"
+          maven_opts="-Dmaven.source.skip=false -Dmaven.javadoc.skip=false -Dgpg.skip=false -Dgpg.passphrase=${{ secrets.GPG_SECRET_KEY_PASSPHRASE }} -DskipTests"
+          ./mvnw $maven_args clean install $maven_opts

.github/workflows/codecov.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Test
-        run: ./mvnw clean test jacoco:report
+        run: ./mvnw --batch-mode clean test jacoco:report
       - name: Codecov
         uses: codecov/codecov-action@v4.0.1
         with:

.github/workflows/license.yml

@@ -15,5 +15,5 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: License Check
-        run: ./mvnw license:check
+      - name: Check License Headers and Dependencies
+        run: ./mvnw --batch-mode license:check

.github/workflows/release.yml

@@ -0,0 +1,25 @@
+name: Release
+on:
+  release:
+    types: [ published ]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Publish
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install GPG Secret Key
+        run: cat <(echo -e "${{ secrets.GPG_SECRET_KEY }}") | gpg --batch --import
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Publish to Central Repository
+        env:
+          CENTRAL_USERNAME_TOKEN: ${{ secrets.CENTRAL_USERNAME_TOKEN }}
+          CENTRAL_PASSWORD_TOKEN: ${{ secrets.CENTRAL_PASSWORD_TOKEN }}
+        run: |
+          maven_args="-s .m2/settings.xml --batch-mode"
+          maven_opts="-Dmaven.source.skip=false -Dmaven.javadoc.skip=false -Dgpg.skip=false -Dgpg.passphrase=${{ secrets.GPG_SECRET_KEY_PASSPHRASE }} -DskipTests"
+          ./mvnw $maven_args clean deploy $maven_opts

.gitignore

@@ -1,5 +1,4 @@
 # Maven
-.m2/
 log/
 target/
 

.m2/settings.xml

@@ -0,0 +1,13 @@
+<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+    <servers>
+        <server>
+            <id>central</id>
+            <username>${env.CENTRAL_USERNAME_TOKEN}</username>
+            <password>${env.CENTRAL_PASSWORD_TOKEN}</password>
+        </server>
+    </servers>
+
+</settings>

.mvn/maven.config

@@ -0,0 +1 @@
+--no-transfer-progress

README.adoc

@@ -51,21 +51,18 @@ APIs are available for the following Xpdf functions (with more to come):
 
 === Documentation
 
-We strongly recommend downloading sources in your IDE so that you have full access to our JavaDocs.
+We strongly recommend downloading sources in your IDE so that you have tooltip access to our JavaDocs.
 We made an extra effort to provide you with all the help you need, directly from your editor.
 
-image::_doc/readme/javadoc_pdftextoptions.jpg[]
-{empty}
-
 We also strongly encourage you to read the Xpdf source documentation for a complete overview of each function and the options available to customize its execution.
 Documentation can be found alongside the executable files in the package resources, or can be downloaded from https://www.xpdfreader.com/download.html[Xpdf] directly.
 
 == PdfText API
 
 PdfText API is an API for _pdftotext_, a function that converts a PDF file into a text file.
 
-* Will extract text from a PDF file with text embedded in the document.
-* Will NOT perform OCR to extract text from a scanned image of a document.
+* It WILL extract text from a PDF file that has embedded text.
+* It WILL NOT extract text from a PDF file that is a scanned image of a document.
 
 === Examples
 

common-api/pom.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-    Common - The components shared between Xpdf APIs.
+    Common - The components shared between Xpdf APIs (https://xpdf.io)
     Copyright © 2024 xpdf.io (info@xpdf.io)
 
     This program is free software: you can redistribute it and/or modify
@@ -30,7 +30,7 @@
     <artifactId>common-api</artifactId>
 
     <name>Common</name>
-    <description>The components shared between Xpdf APIs.</description>
+    <description>The components shared between Xpdf APIs (https://xpdf.io)</description>
     <url>https://xpdf.io</url>
     <licenses>
         <license>

common-api/src/main/java/io/xpdf/api/common/XpdfRequest.java

@@ -1,5 +1,5 @@
 /*
- * Common - The components shared between Xpdf APIs.
+ * Common - The components shared between Xpdf APIs (https://xpdf.io)
  * Copyright © 2024 xpdf.io (info@xpdf.io)
  *
  * This program is free software: you can redistribute it and/or modify

common-api/src/main/java/io/xpdf/api/common/XpdfResponse.java

@@ -1,5 +1,5 @@
 /*
- * Common - The components shared between Xpdf APIs.
+ * Common - The components shared between Xpdf APIs (https://xpdf.io)
  * Copyright © 2024 xpdf.io (info@xpdf.io)
  *
  * This program is free software: you can redistribute it and/or modify

common-api/src/main/java/io/xpdf/api/common/XpdfTool.java

@@ -1,5 +1,5 @@
 /*
- * Common - The components shared between Xpdf APIs.
+ * Common - The components shared between Xpdf APIs (https://xpdf.io)
  * Copyright © 2024 xpdf.io (info@xpdf.io)
  *
  * This program is free software: you can redistribute it and/or modify

common-api/src/main/java/io/xpdf/api/common/exception/XpdfException.java

@@ -1,5 +1,5 @@
 /*
- * Common - The components shared between Xpdf APIs.
+ * Common - The components shared between Xpdf APIs (https://xpdf.io)
  * Copyright © 2024 xpdf.io (info@xpdf.io)
  *
  * This program is free software: you can redistribute it and/or modify

common-api/src/main/java/io/xpdf/api/common/exception/XpdfExecutionException.java

@@ -1,5 +1,5 @@
 /*
- * Common - The components shared between Xpdf APIs.
+ * Common - The components shared between Xpdf APIs (https://xpdf.io)
  * Copyright © 2024 xpdf.io (info@xpdf.io)
  *
  * This program is free software: you can redistribute it and/or modify

common-api/src/main/java/io/xpdf/api/common/exception/XpdfProcessingException.java

@@ -1,5 +1,5 @@
 /*
- * Common - The components shared between Xpdf APIs.
+ * Common - The components shared between Xpdf APIs (https://xpdf.io)
  * Copyright © 2024 xpdf.io (info@xpdf.io)
  *
  * This program is free software: you can redistribute it and/or modify

common-api/src/main/java/io/xpdf/api/common/exception/XpdfRuntimeException.java

@@ -1,5 +1,5 @@
 /*
- * Common - The components shared between Xpdf APIs.
+ * Common - The components shared between Xpdf APIs (https://xpdf.io)
  * Copyright © 2024 xpdf.io (info@xpdf.io)
  *
  * This program is free software: you can redistribute it and/or modify