ci: add verified plugin release pipeline

.github/workflows/build.yml

@@ -8,22 +8,44 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
 
       - name: Set up JDK 21
-        uses: actions/setup-java@v4
+        uses: actions/setup-java@v6
         with:
           distribution: temurin
           java-version: '21'
           cache: maven
 
-      - name: Build with Maven
-        run: mvn --batch-mode clean package
+      - name: Set dated development version
+        id: dev
+        shell: bash
+        run: |
+          dev_version="DEV-$(date -u +%Y%m%d-%H%M)"
+          mvn -B --no-transfer-progress org.codehaus.mojo:versions-maven-plugin:2.22.0:set \
+            -DnewVersion="$dev_version" -DgenerateBackupPoms=false
+          mvn -B --no-transfer-progress help:evaluate \
+            -Dexpression=project.build.finalName -Doutput="$RUNNER_TEMP/final-name"
+          final_name=$(cat "$RUNNER_TEMP/final-name")
+          echo "name=$final_name" >> "$GITHUB_OUTPUT"
+          echo "jar=target/$final_name.jar" >> "$GITHUB_OUTPUT"
+
+      - name: Run unit tests and build
+        run: mvn -B --no-transfer-progress clean verify -DskipTests=false -Dmaven.test.skip=false
 
       - name: Upload plugin jar
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v7
+        with:
+          name: ${{ steps.dev.outputs.name }}-${{ github.run_id }}-${{ github.run_attempt }}
+          path: ${{ steps.dev.outputs.jar }}
+          if-no-files-found: error
+
+      - name: Upload unit test reports
+        if: ${{ !cancelled() && hashFiles('target/surefire-reports/*.xml') != '' }}
+        uses: actions/upload-artifact@v7
         with:
-          name: geiger_counter
-          path: target/geiger_counter-*.jar
+          name: unit-test-reports-${{ github.run_id }}-${{ github.run_attempt }}
+          path: target/surefire-reports/
+          if-no-files-found: error

.github/workflows/maven-release.yml

@@ -0,0 +1,135 @@
+name: Maven plugin release
+
+on:
+  workflow_call:
+    inputs:
+      java-version:
+        required: true
+        type: string
+      artifact-path:
+        description: Exact deployable JAR path, with optional {version} placeholder
+        required: true
+        type: string
+    secrets:
+      DEPS_TOKEN:
+        required: false
+
+permissions:
+  contents: read
+
+concurrency:
+  group: plugin-release-${{ github.repository }}-${{ github.ref }}
+  cancel-in-progress: false
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build:
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-24.04
+    timeout-minutes: 20
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - uses: actions/setup-java@v6
+        with:
+          distribution: temurin
+          java-version: ${{ inputs.java-version }}
+
+      - name: Validate release version
+        env:
+          TAG: ${{ github.ref_name }}
+        run: |
+          [[ "$TAG" =~ ^v[0-9]+\.[0-9]+(\.[0-9]+)?(-[0-9A-Za-z]+([.-][0-9A-Za-z]+)*)?$ ]] || {
+            echo '::error::Expected vMAJOR.MINOR or vMAJOR.MINOR.PATCH, with an optional prerelease suffix.'
+            exit 1
+          }
+          [[ "${TAG^^}" != *SNAPSHOT* ]] || exit 1
+
+      - name: Prepare pinned dependencies
+        env:
+          GH_TOKEN: ${{ secrets.DEPS_TOKEN }}
+        run: |
+          if [[ -f .github/scripts/prepare-release.sh ]]; then
+            bash .github/scripts/prepare-release.sh
+          fi
+
+      - name: Check Maven version and build
+        env:
+          TAG: ${{ github.ref_name }}
+        run: |
+          version_file="$RUNNER_TEMP/maven-release-version"
+          mvn -B --no-transfer-progress -P'!deploy-live' help:evaluate \
+            -Dexpression=project.version -Doutput="$version_file"
+          [[ "$(cat "$version_file")" == "${TAG#v}" ]] || {
+            echo '::error::The tag must match project.version exactly.'
+            exit 1
+          }
+          mvn -B --no-transfer-progress -P'!deploy-live' clean verify
+
+      - name: Stage only the release JAR
+        env:
+          ARTIFACT_PATH: ${{ inputs.artifact-path }}
+          TAG: ${{ github.ref_name }}
+        run: |
+          python3 - <<'PY'
+          import hashlib, json, os, pathlib, shutil, zipfile
+          root = pathlib.Path.cwd().resolve()
+          source = (root / os.environ['ARTIFACT_PATH'].replace('{version}', os.environ['TAG'][1:])).resolve()
+          if not source.is_relative_to(root / 'target') or not source.is_file() or source.suffix != '.jar':
+              raise SystemExit('Expected one existing JAR inside target/')
+          with zipfile.ZipFile(source) as jar:
+              if not {'plugin.yml', 'paper-plugin.yml'}.intersection(jar.namelist()):
+                  raise SystemExit('Release JAR has no plugin descriptor')
+              if jar.testzip() is not None:
+                  raise SystemExit('Release JAR is corrupt')
+          dest = pathlib.Path(os.environ['RUNNER_TEMP']) / 'plugin-release'
+          dest.mkdir()
+          shutil.copyfile(source, dest / source.name)
+          digest = hashlib.sha256((dest / source.name).read_bytes()).hexdigest()
+          (dest / 'SHA256SUMS').write_text(f'{digest}  {source.name}\n')
+          (dest / 'build.json').write_text(json.dumps({
+              'repository': os.environ['GITHUB_REPOSITORY'],
+              'commit': os.environ['GITHUB_SHA'],
+              'tag': os.environ['TAG'],
+              'run': f"{os.environ['GITHUB_SERVER_URL']}/{os.environ['GITHUB_REPOSITORY']}/actions/runs/{os.environ['GITHUB_RUN_ID']}",
+              'artifact': source.name,
+              'sha256': digest,
+          }, indent=2) + '\n')
+          PY
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: plugin-release-${{ github.sha }}
+          path: ${{ runner.temp }}/plugin-release/
+          if-no-files-found: error
+          retention-days: 30
+
+  publish:
+    needs: build
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: plugin-release-${{ github.sha }}
+          path: release
+
+      - name: Create draft release
+        working-directory: release
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+          TAG: ${{ github.ref_name }}
+        run: |
+          sha256sum --check SHA256SUMS
+          flags=()
+          if [[ "$TAG" == *-* ]]; then flags+=(--prerelease); fi
+          gh release create "$TAG" ./*.jar SHA256SUMS build.json \
+            --verify-tag --draft --title "$TAG" --generate-notes "${flags[@]}"

.github/workflows/release.yml

@@ -5,47 +5,14 @@ on:
     tags: ['v*']
 
 permissions:
-  contents: write
+  contents: read
 
 jobs:
   release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - name: Set up JDK 21
-        uses: actions/setup-java@v4
-        with:
-          distribution: temurin
-          java-version: '21'
-          cache: maven
-
-      - name: Build with Maven
-        run: mvn --batch-mode clean package
-
-      # Auto-generated notes only list merged PRs; this repo commits straight
-      # to main, so build the changelog from commit messages instead
-      - name: Generate changelog from commits
-        run: |
-          prev=$(git describe --tags --abbrev=0 "${GITHUB_REF_NAME}^" 2>/dev/null || true)
-          {
-            echo "## What's Changed"
-            echo
-            if [ -n "$prev" ]; then
-              git log --no-merges --pretty='- %s' "$prev..${GITHUB_REF_NAME}"
-              echo
-              echo "**Full Changelog**: https://github.com/${GITHUB_REPOSITORY}/compare/$prev...${GITHUB_REF_NAME}"
-            else
-              git log --no-merges --pretty='- %s' "${GITHUB_REF_NAME}"
-              echo
-              echo "**Full Changelog**: https://github.com/${GITHUB_REPOSITORY}/commits/${GITHUB_REF_NAME}"
-            fi
-          } > RELEASE_NOTES.md
-
-      - name: Create GitHub release
-        uses: softprops/action-gh-release@v2
-        with:
-          files: target/geiger_counter-*.jar
-          body_path: RELEASE_NOTES.md
+    permissions:
+      contents: write
+    uses: ./.github/workflows/maven-release.yml
+    with:
+      java-version: '21'
+      # Exact path, not a glob. {version} is replaced with the tag without v.
+      artifact-path: target/geiger_counter-{version}.jar

pom.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="UTF-8"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://www.apache.org/xsd/maven-4.0.0.xsd">
@@ -68,6 +68,18 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+                <includes><include>plugin.yml</include></includes>
+            </resource>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>false</filtering>
+                <excludes><exclude>plugin.yml</exclude></excludes>
+            </resource>
+        </resources>
         <plugins>
             <!-- Shade bStats into the jar (relocated, as bStats requires) -->
             <plugin>
@@ -96,21 +108,6 @@
                 </executions>
             </plugin>
 
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-antrun-plugin</artifactId>
-                <executions>
-                    <execution>
-                        <phase>package</phase>
-                        <goals><goal>run</goal></goals>
-                        <configuration>
-                            <target>
-                                <copy file="${project.build.directory}/${project.build.finalName}.jar" tofile="${project.basedir}/${project.build.finalName}.jar"/>
-                            </target>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
         </plugins>
     </build>
 </project>

src/main/resources/plugin.yml

@@ -1,5 +1,5 @@
 main: tfmc.justin.geiger_counter
-version: 1.1.3
+version: ${project.version}
 name: geiger_counter
 author: Justin
 api-version: 1.21