Merge branch 'release/4.0.1'

Release: com.io7m.jaffirm 4.0.1
Change: Update com.io7m.junreachable:com.io7m.junreachable.core 4.0.0 → 4.0.2.
Change: Update com.io7m.immutables.style 0.0.1 → 1.0.0.
Change: Update org.immutables:value:2.10.0 → 2.10.1.
Change: Update org.junit.jupiter:junit-jupiter-api:5.10.1 → 5.10.2.
Change: Update org.junit.jupiter:junit-jupiter-engine:5.10.1 → 5.10.2.

.github/dependabot.yml

@@ -0,0 +1,18 @@
+
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+
+    target-branch: "develop"
+    ignore:
+      - dependency-name: "*"
+        update-types: [ "version-update:semver-major" ]

.github/workflows/Tools.java

@@ -0,0 +1,162 @@
+/*
+ * Copyright © 2024 Mark Raynsford <[email protected]> https://www.io7m.com
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+ * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+ * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathFactory;
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+import java.util.TreeMap;
+
+public final class Tools
+{
+  private static final TreeMap<String, OpType> OPS =
+    new TreeMap<>();
+
+  static {
+    final var opsList = List.of(
+      new ShowProjectVersion(),
+      new ShowProjectIsSnapshot()
+    );
+
+    for (final var op : opsList) {
+      OPS.put(op.name(), op);
+    }
+  }
+
+  private Tools()
+  {
+
+  }
+
+  private interface OpType
+  {
+    String name();
+
+    void execute(String[] args)
+      throws Exception;
+  }
+
+  private static String getProjectVersion(
+    final File file)
+    throws Exception
+  {
+    final var documentBuilders =
+      DocumentBuilderFactory.newInstance();
+    final var documentBuilder =
+      documentBuilders.newDocumentBuilder();
+    final var document =
+      documentBuilder.parse(file);
+
+    final var xPathFactory =
+      XPathFactory.newInstance();
+    final var xPath =
+      xPathFactory.newXPath();
+
+    final var nodes =
+      (NodeList) xPath.evaluate(
+        "//project/version",
+        document,
+        XPathConstants.NODESET
+      );
+
+    for (var i = 0; i < nodes.getLength(); i++) {
+      final var node = nodes.item(i);
+      if (node.getNodeType() == Node.ELEMENT_NODE) {
+        return node.getTextContent().trim();
+      }
+    }
+
+    throw new IOException(
+      "Could not locate a //project/version node!"
+    );
+  }
+
+  private static final class ShowProjectVersion implements OpType
+  {
+    ShowProjectVersion()
+    {
+
+    }
+
+    @Override
+    public String name()
+    {
+      return "ShowProjectVersion";
+    }
+
+    @Override
+    public void execute(
+      final String[] args)
+      throws Exception
+    {
+      System.out.print("IO7M_PROJECT_VERSION=");
+      System.out.println(getProjectVersion(new File(args[1])));
+    }
+  }
+
+  private static final class ShowProjectIsSnapshot implements OpType
+  {
+    ShowProjectIsSnapshot()
+    {
+
+    }
+
+    @Override
+    public String name()
+    {
+      return "ShowProjectIsSnapshot";
+    }
+
+    @Override
+    public void execute(
+      final String[] args)
+      throws Exception
+    {
+      System.out.print("IO7M_PROJECT_VERSION_IS_SNAPSHOT=");
+      System.out.println(
+        getProjectVersion(new File(args[1])).endsWith("-SNAPSHOT")
+      );
+    }
+  }
+
+  public static void main(
+    final String[] args)
+    throws Exception
+  {
+    if (args.length == 0) {
+      System.err.println("Usage: command");
+      System.exit(1);
+    }
+
+    final var op = OPS.get(args[0]);
+    if (op == null) {
+      System.err.println("Unrecognized command.");
+      System.err.println("  Must be one of:");
+      for (final var name : OPS.keySet()) {
+        System.err.print("    ");
+        System.err.println(name);
+      }
+      System.exit(1);
+    }
+
+    op.execute(args);
+  }
+}

.github/workflows/deploy-release.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+
+fatal()
+{
+  echo "fatal: $1" 1>&2
+  exit 1
+}
+
+if [ -z "${MAVEN_CENTRAL_USERNAME}" ]
+then
+  fatal "MAVEN_CENTRAL_USERNAME is not set."
+fi
+
+if [ -z "${MAVEN_CENTRAL_PASSWORD}" ]
+then
+  fatal "MAVEN_CENTRAL_PASSWORD is not set."
+fi
+
+(cat <<EOF
+<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">
+
+  <profiles>
+    <profile>
+      <id>io7m</id>
+      <properties>
+        <gpg.useagent>true</gpg.useagent>
+        <gpg.keyname>github-ci-maven-rsa-key</gpg.keyname>
+        <io7m.deployment>true</io7m.deployment>
+      </properties>
+    </profile>
+  </profiles>
+
+  <servers>
+    <server>
+      <id>sonatype-nexus-snapshots</id>
+      <username>${MAVEN_CENTRAL_USERNAME}</username>
+      <password>${MAVEN_CENTRAL_PASSWORD}</password>
+    </server>
+    <server>
+      <id>sonatype-nexus-staging</id>
+      <username>${MAVEN_CENTRAL_USERNAME}</username>
+      <password>${MAVEN_CENTRAL_PASSWORD}</password>
+    </server>
+  </servers>
+</settings>
+EOF
+) > "$HOME/.m2/settings.xml" || fatal "could not update $HOME/.m2/settings.xml"
+
+exec mvn \
+-Dio7m.release=true \
+-Dio7m.deployment=true \
+--batch-mode \
+--strict-checksums \
+-DskipTests=true \
+-DskipITs=true deploy

.github/workflows/deploy-snapshot.sh

@@ -0,0 +1,44 @@
+#!/bin/sh
+
+fatal()
+{
+  echo "fatal: $1" 1>&2
+  exit 1
+}
+
+if [ -z "${MAVEN_CENTRAL_USERNAME}" ]
+then
+  fatal "MAVEN_CENTRAL_USERNAME is not set."
+fi
+
+if [ -z "${MAVEN_CENTRAL_PASSWORD}" ]
+then
+  fatal "MAVEN_CENTRAL_PASSWORD is not set."
+fi
+
+(cat <<EOF
+<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-nexus-snapshots</id>
+      <username>${MAVEN_CENTRAL_USERNAME}</username>
+      <password>${MAVEN_CENTRAL_PASSWORD}</password>
+    </server>
+    <server>
+      <id>sonatype-nexus-staging</id>
+      <username>${MAVEN_CENTRAL_USERNAME}</username>
+      <password>${MAVEN_CENTRAL_PASSWORD}</password>
+    </server>
+  </servers>
+</settings>
+EOF
+) > "$HOME/.m2/settings.xml" || fatal "could not update $HOME/.m2/settings.xml"
+
+exec mvn \
+--batch-mode \
+--strict-checksums \
+-DskipTests=true \
+-DskipITs=true deploy

.github/workflows/deploy.linux.temurin.lts.yml

@@ -0,0 +1,30 @@
+name: deploy.linux.temurin.lts
+
+on:
+  push:
+    tags: [ com.io7m.jaffirm-* ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: JDK
+        uses: actions/setup-java@v4
+        with:
+          java-version: 21
+          distribution: 'temurin'
+
+      - name: Import signing key
+        env:
+          PGP_SIGNING_KEY: ${{ secrets.PGP_SIGNING_KEY }}
+        run: echo "${PGP_SIGNING_KEY}" | gpg --import
+
+      - name: Deploy release
+        env:
+          MAVEN_CENTRAL_USERNAME: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
+          MAVEN_CENTRAL_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
+        run: .github/workflows/deploy-release.sh