add ide config and update pipelines

.github/workflows/main.yml

@@ -1,45 +1,14 @@
-name: Publish package to GitHub Packages
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: "Version name to publish (eg: x.x.x)"
-        type: string
-        required: true
-
-jobs:
-  publish:
-    timeout-minutes: 15
-    runs-on: ubuntu-22.04
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-      - uses: actions/checkout@v3
+name: Test
 
-      - uses: aboutbits/github-actions-java/setup-and-install@v1
-        with:
-          java-version: 21
-
-      - name: Set Version
-        run: sed -i 's|<version>BUILD-SNAPSHOT</version>|<version>${{ github.event.inputs.version }}</version>|g' pom.xml
-
-      - name: Publish package
-        run: mvn --batch-mode deploy
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+on:
+  pull_request:
+    types: [ opened, reopened, synchronize ]
 
-  tag:
-    timeout-minutes: 5
-    runs-on: ubuntu-22.04
-    needs: publish
-    steps:
-      - uses: actions/checkout@v3
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
 
-      - name: Tag Deployment
-        uses: aboutbits/github-actions-base/git-create-or-update-tag@v1
-        with:
-          tag-name: ${{ github.event.inputs.version }}
-          user-name: 'AboutBits'
-          user-email: '[email protected]'
+jobs:
+  test:
+    name: Tests
+    uses: ./.github/workflows/test.yml

.github/workflows/maven-settings.xml

@@ -0,0 +1,33 @@
+<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
+                      http://maven.apache.org/xsd/settings-1.0.0.xsd">
+
+    <activeProfiles>
+        <activeProfile>github</activeProfile>
+    </activeProfiles>
+
+    <profiles>
+        <profile>
+            <id>github</id>
+            <repositories>
+                <repository>
+                    <id>central</id>
+                    <url>https://repo1.maven.org/maven2</url>
+                </repository>
+                <repository>
+                    <id>github</id>
+                    <url>https://maven.pkg.github.com/aboutbits/*</url>
+                </repository>
+            </repositories>
+        </profile>
+    </profiles>
+
+    <servers>
+        <server>
+            <id>github</id>
+            <username>${env.GITHUB_USER_NAME}</username>
+            <password>${env.GITHUB_ACCESS_TOKEN}</password>
+        </server>
+    </servers>
+</settings>

.github/workflows/publish.yml

@@ -0,0 +1,43 @@
+name: Publish package to GitHub Packages
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version name to publish (eg: x.x.x)"
+        type: string
+        required: true
+
+jobs:
+  publish:
+    timeout-minutes: 15
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: aboutbits/github-actions-java/setup-and-install@v3
+
+      - name: Set Version
+        run: sed -i 's|<version>BUILD-SNAPSHOT</version>|<version>${{ github.event.inputs.version }}</version>|g' pom.xml
+
+      - name: Publish package
+        run: mvn --batch-mode deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  tag:
+    timeout-minutes: 5
+    runs-on: ubuntu-22.04
+    needs: publish
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Tag Deployment
+        uses: aboutbits/github-actions-base/git-create-or-update-tag@v1
+        with:
+          tag-name: ${{ github.event.inputs.version }}
+          user-name: 'AboutBits'
+          user-email: '[email protected]'

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Tests
+
+on:
+  workflow_call:
+
+jobs:
+  test:
+    name: Maven-Java
+    runs-on: ubuntu-22.04
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: aboutbits/github-actions-java/setup@v3
+        with:
+          java-version: 21
+      - run: >-
+          ./mvnw
+          -s $GITHUB_WORKSPACE/.github/workflows/maven-settings.xml
+          --batch-mode
+          --fail-fast
+          -Dsurefire.failIfNoSpecifiedTests=false
+          test
+        env:
+          GITHUB_USER_NAME: ${{ github.actor }}
+          GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -14,10 +14,19 @@ target/
 .sts4-cache
 
 ### IntelliJ IDEA ###
-.idea
-*.iws
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+.idea/*
+!.idea/codeStyles
+!.idea/.gitignore
+!.idea/checkstyle-idea.xml
+!.idea/encodings.xml
+!.idea/misc.xml
+!.idea/sqldialects.xml
+!.idea/vcs.xml
+
 *.iml
 *.ipr
+*.iws
 
 ### NetBeans ###
 /nbproject/private/

readme.md

@@ -80,6 +80,14 @@ The following configuration options are available:
 | `lib.emailservice.scheduling.enabled`  | true        | Enables the scheduler sending the emails.                             |
 | `lib.emailservice.scheduling.interval` | 30000       | Specifies the milliseconds delay between runs of the scheduler.       |
 
+## Local development:
+
+To use this library as a local development dependency, you can simply refer to the version `BUILD-SNAPSHOT`.
+
+Check out this repository and run the maven goal `install`. This will build and install this library as version `BUILD-SNAPSHOT` into your local maven cache.
+
+Note that you may have to tell your IDE to reload your main maven project each time you build the library.
+
 ## Building and releasing a new version:
 
 To create a new version of this package and push it to the maven registry, you will have to use the GitHub actions workflow and manually trigger it.