Build & Distribute via GitHub Packages

This sets up GitHub Actions that build and publish this project as a Maven artifact, using the Maven repository provided by GitHub.

```xml
<repository>
    <id>github</id>
    <name>GitHub GoodBytes LinkDetector Apache Maven Packages</name>
    <url>https://maven.pkg.github.com/goodbytes/linkdetector</url>
</repository>
```

You can then define this project to be a dependency of your project, like so:

```xml
<dependency>
    <groupId>nl.goodbytes.util</groupId>
    <artifactId>linkdetector</artifactId>
    <version>1.0.0</version> <!-- Please remember to check if this is the latest, as this example could be outdated. -->
</dependency>
```

Author: guusdk

.github/workflows/maven-build.yml

@@ -0,0 +1,30 @@
+name: Maven Build & Test
+
+on: [pull_request]
+
+permissions:
+  checks: write
+
+jobs:
+  build-java:
+    name: Build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java: [ 8, 11, 17, 21 ]
+        distribution: [ temurin ] # We could add more here: temurin, adopt, liberica, microsoft, corretto
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK ${{ matrix.java }} ${{ matrix.distribution }}
+        uses: actions/setup-java@v4
+        with:
+          java-version: ${{ matrix.java }}
+          distribution: ${{ matrix.distribution }}
+          cache: maven
+      - name: Build with Maven
+        run: mvn --batch-mode --update-snapshots verify
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@v5
+        if: ${{ matrix.java == 8 && (success() || failure()) }}  # always run even if the previous step fails
+        with:
+          report_paths: '**/target/surefire-reports/TEST-*.xml'

.github/workflows/maven-publish.yml

@@ -0,0 +1,34 @@
+# This workflow will build a package using Maven and then publish it to GitHub packages when a release is created
+# For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#apache-maven-with-a-settings-path
+
+name: Maven Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 8
+        uses: actions/setup-java@v4
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+          server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
+          settings-path: ${{ github.workspace }} # Location where the settings.xml file will be generated.
+
+      - name: Build with Maven
+        run: mvn -B package --file pom.xml
+
+      - name: Publish to GitHub Packages Apache Maven
+        run: mvn deploy -s $GITHUB_WORKSPACE/settings.xml
+        env:
+          GITHUB_TOKEN: ${{ github.token }}

pom.xml

@@ -41,4 +41,12 @@
         </dependency>
     </dependencies>
 
+    <distributionManagement>
+        <repository>
+            <id>github</id>
+            <name>GitHub GoodBytes LinkDetector Apache Maven Packages</name>
+            <url>https://maven.pkg.github.com/goodbytes/linkdetector</url>
+        </repository>
+    </distributionManagement>
+
 </project>

readme.md

@@ -8,8 +8,29 @@ that effort.
 
 ## Usage
 
-To use the utility, invoke the `parse` method of the `LinkDetector` class, as shown below. This will split up the text
-in fragments (returned in a list). For each fragment, a start and end index is provided, and defines if it does or does
+The distributable is available through the Maven repository that is provided by GitHub Packages. To set it up, define
+the repository in your `pom.xml` file like so:
+
+```xml
+<repository>
+    <id>github</id>
+    <name>GitHub GoodBytes LinkDetector Apache Maven Packages</name>
+    <url>https://maven.pkg.github.com/goodbytes/linkdetector</url>
+</repository>
+```
+
+You can then define this project to be a dependency of your project, like so:
+
+```xml
+<dependency>
+    <groupId>nl.goodbytes.util</groupId>
+    <artifactId>linkdetector</artifactId>
+    <version>1.0.0</version> <!-- Please remember to check if this is the latest, as this example could be outdated. -->
+</dependency>
+```
+
+To use the utility in your code, invoke the `parse` method of the `LinkDetector` class, as shown below. This will split
+up the text in fragments (returned in a list). For each fragment, a start and end index is provided, and defines if it does or does
 not represent a link.
 
 ```java