1.0.0 release

.github-actions/maven/github-package-registry-settings.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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">
+    <servers>
+        <server>
+            <id>github-package-registry</id>
+            <username>${env.GITHUB_PACKAGE_REGISTRY_DEPLOYER}</username>
+            <password>${env.GITHUB_PACKAGE_REGISTRY_TOKEN}</password>
+        </server>
+    </servers>
+
+    <profiles>
+        <profile>
+            <id>import-env-code-signing-credentials</id>
+            <properties>
+                <gpg.executable>gpg</gpg.executable>
+                <gpg.keyname>${env.CODE_SIGNING_GPG_KEY_ID}</gpg.keyname>
+                <gpg.passphrase>${env.CODE_SIGNING_GPG_KEY_PASSPHRASE}</gpg.passphrase>
+            </properties>
+        </profile>
+    </profiles>
+</settings>

.github-actions/maven/sonatype-ossrh-settings.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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">
+    <servers>
+        <server>
+            <id>sonatype-ossrh</id>
+            <username>${env.SONATYPE_OSSRH_DEPLOYER}</username>
+            <password>${env.SONATYPE_OSSRH_TOKEN}</password>
+        </server>
+    </servers>
+
+    <profiles>
+        <profile>
+            <id>import-env-code-signing-credentials</id>
+            <properties>
+                <gpg.executable>gpg</gpg.executable>
+                <gpg.keyname>${env.CODE_SIGNING_GPG_KEY_ID}</gpg.keyname>
+                <gpg.passphrase>${env.CODE_SIGNING_GPG_KEY_PASSPHRASE}</gpg.passphrase>
+            </properties>
+        </profile>
+    </profiles>
+</settings>

.github-actions/scripts/get_version.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+# This should be called from repository root
+
+# shellcheck disable=SC2016
+# this is intentional as it is the value passed to Maven
+mvn -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec --quiet

.github-actions/scripts/maven_deploy.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+# This should be called from repository root
+
+if [[ "$(./.github-actions/scripts/get_version.sh)" == *-SNAPSHOT ]]; then
+  if [[ $1 == release ]]; then
+    >&2 echo "Cannot deploy in release mode when version is snapshot"
+    exit 1;
+  fi
+else
+  if [[ $1 != release ]]; then
+    >&2 echo "Cannot deploy in non-release mode when version is not snapshot"
+    exit 1;
+  fi;
+fi
+
+
+# Valid deployment modes:
+# - sonatype-ossrh
+# - github-package-registry
+function deploy() {
+  if [[ $1 != sonatype-ossrh && $1 != github-package-registry ]]; then
+    echo "Unknown deployment target: $1"
+    return 1
+  fi
+
+  maven_profiles=build-extras,sign-artifacts,import-env-code-signing-credentials,"$1"-deployment
+  if [[ $2 == release && $1 == sonatype-ossrh ]]; then
+    maven_profiles="${maven_profiles},automatic-central-release"
+  fi
+  echo "Using maven profiles: [${maven_profiles}]"
+
+  mvn deploy --settings ./.github-actions/maven/"$1"-settings.xml --activate-profiles "$maven_profiles" -B -V
+}
+
+deploy sonatype-ossrh "$1"
+deploy github-package-registry "$1"

.github/dependabot.yml

@@ -0,0 +1,25 @@
+version: 2
+updates:
+  - package-ecosystem: maven
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: development
+    reviewers:
+      - JarvisCraft
+    labels:
+      - dependencies
+      - automatic
+
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    target-branch: development
+    reviewers:
+      - JarvisCraft
+    labels:
+      - dependencies
+      - automatic

.github/workflows/deploy-release.yml

@@ -0,0 +1,40 @@
+name: Deploy release
+
+on:
+  push:
+    tags: [ v* ]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3.3.0
+
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'adopt'
+          java-version: '8'
+
+      - name: Cache Maven local repository
+        uses: actions/cache@v3.2.2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-maven-
+
+      - name: Import GPG signing key
+        run: |
+          echo -e "${{ secrets.CODE_SIGNING_GPG_PRIVATE_KEY }}" | gpg --batch --import
+          gpg --list-secret-keys --keyid-format LONG
+
+      - name: Deploy snapshot
+        env:
+          CODE_SIGNING_GPG_KEY_ID: ${{ secrets.CODE_SIGNING_GPG_KEY_ID }}
+          CODE_SIGNING_GPG_KEY_PASSPHRASE: ${{ secrets.CODE_SIGNING_GPG_KEY_PASSPHRASE }}
+          SONATYPE_OSSRH_DEPLOYER: ${{ secrets.SONATYPE_OSSRH_DEPLOYER }}
+          SONATYPE_OSSRH_TOKEN: ${{ secrets.SONATYPE_OSSRH_TOKEN }}
+          GITHUB_PACKAGE_REGISTRY_DEPLOYER: JarvisCraft
+          GITHUB_PACKAGE_REGISTRY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: ./.github-actions/scripts/maven_deploy.sh release

.github/workflows/deploy-snapshot.yml

@@ -0,0 +1,41 @@
+name: Deploy snapshot
+
+on:
+  push:
+    branches: [ development ]
+  workflow_dispatch: {}
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3.3.0
+
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'adopt'
+          java-version: '8'
+
+      - name: Cache Maven local repository
+        uses: actions/cache@v3.2.2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-maven-
+
+      - name: Import GPG signing key
+        run: |
+          echo -e "${{ secrets.CODE_SIGNING_GPG_PRIVATE_KEY }}" | gpg --batch --import
+          gpg --list-secret-keys --keyid-format LONG
+
+      - name: Deploy snapshot
+        env:
+          CODE_SIGNING_GPG_KEY_ID: ${{ secrets.CODE_SIGNING_GPG_KEY_ID }}
+          CODE_SIGNING_GPG_KEY_PASSPHRASE: ${{ secrets.CODE_SIGNING_GPG_KEY_PASSPHRASE }}
+          SONATYPE_OSSRH_DEPLOYER: ${{ secrets.SONATYPE_OSSRH_DEPLOYER }}
+          SONATYPE_OSSRH_TOKEN: ${{ secrets.SONATYPE_OSSRH_TOKEN }}
+          GITHUB_PACKAGE_REGISTRY_DEPLOYER: JarvisCraft
+          GITHUB_PACKAGE_REGISTRY_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: ./.github-actions/scripts/maven_deploy.sh

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+# Only test (without creating JARs) pull-requests
+on: [ pull_request, workflow_dispatch ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3.3.0
+
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'adopt'
+          java-version: '8'
+
+      - name: Cache Maven local repository
+        uses: actions/cache@v3.2.2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: ${{ runner.os }}-maven-
+
+      - name: Build with Maven
+        run: mvn -B test

.gitignore

@@ -1,8 +1,8 @@
-
-# Created by https://www.gitignore.io/api/maven,intellij+all
+# Created by https://www.toptal.com/developers/gitignore/api/intellij+all,maven,java
+# Edit at https://www.toptal.com/developers/gitignore?templates=intellij+all,maven,java
 
 ### Intellij+all ###
-# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
 # User-specific stuff
@@ -32,9 +32,14 @@
 # When using Gradle or Maven with auto-import, you should exclude module files,
 # since they will be recreated, and may cause churn.  Uncomment if using
 # auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
 # .idea/modules.xml
 # .idea/*.iml
 # .idea/modules
+# *.iml
+# *.ipr
 
 # CMake
 cmake-build-*/
@@ -82,6 +87,34 @@ modules.xml
 .idea/misc.xml
 *.ipr
 
+# Sonarlint plugin
+.idea/sonarlint
+
+### Java ###
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
 ### Maven ###
 target/
 pom.xml.tag
@@ -92,10 +125,7 @@ release.properties
 dependency-reduced-pom.xml
 buildNumber.properties
 .mvn/timing.properties
+# https://github.com/takari/maven-wrapper#usage-without-binary-jar
 .mvn/wrapper/maven-wrapper.jar
 
-
-# End of https://www.gitignore.io/api/maven,intellij+all
-
-### Security ###
-*.asc
+# End of https://www.toptal.com/developers/gitignore/api/intellij+all,maven,java

.mergify.yml

@@ -0,0 +1,25 @@
+pull_request_rules:
+  - name: Automatic merge for labelled pull requests
+    conditions:
+      - label=merge when ready
+    actions:
+      merge:
+        method: merge
+        strict: smart+fasttrack
+
+  - name: Automatic merge for Dependabot pull requests
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+      - base=development
+    actions:
+      merge:
+        method: merge
+        strict: smart+fasttrack
+
+  - name: Remove Mergify temporary labels
+    conditions:
+      - merged
+    actions:
+      label:
+        remove:
+          - merge when ready

.mergifyio.yml

@@ -0,0 +1,25 @@
+pull_request_rules:
+  - name: Automatic merge for labelled pull requests
+    conditions:
+      - label=merge when ready
+    actions:
+      merge:
+        method: merge
+        strict: smart+fasttrack
+
+  - name: Automatic merge for Dependabot pull requests
+    conditions:
+      - author~=^dependabot(|-preview)\[bot\]$
+      - base=development
+    actions:
+      merge:
+        method: merge
+        strict: smart+fasttrack
+
+  - name: Remove Mergify temporary labels
+    conditions:
+      - merged
+    actions:
+      label:
+        remove:
+          - merge when ready