chore(ci): add github actions and semantic release

Author: TheMeinerLP

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master, develop]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: "21"
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          cache-read-only: ${{ github.event_name == 'pull_request' }}
+
+      - name: Build
+        run: ./gradlew build

.github/workflows/release.yml

@@ -0,0 +1,75 @@
+name: Release
+
+on:
+  push:
+    branches: [main, master]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: "21"
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          cache-read-only: true
+
+      - name: Build
+        run: ./gradlew build
+
+  release:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: "21"
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          cache-read-only: true
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: pnpm
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.12.3
+
+      - name: Install release tooling
+        run: pnpm install --no-lockfile
+
+      - name: Configure Git user
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Run semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: pnpm run release

.gitignore

@@ -23,6 +23,7 @@ hs_err_pid*
 .idea/**/dynamic.xml
 .idea/**/uiDesigner.xml
 .idea/**/dbnavigator.xml
+.idea/
 .idea/**/gradle.xml
 .idea/**/libraries
 cmake-build-*/
@@ -44,4 +45,7 @@ fabric.properties
 gradle-app.setting
 !gradle-wrapper.jar
 .gradletasknamecache
-run/
+run/
+node_modules/
+pnpm-debug.log
+tsconfig.tsbuildinfo

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to this project will be documented in this file by semantic-release.

package.json

@@ -0,0 +1,26 @@
+{
+  "name": "voyager-release-tools",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Semantic-release setup for the Voyager build",
+  "license": "UNLICENSED",
+  "engines": {
+    "node": ">=18"
+  },
+  "packageManager": "pnpm@9.12.3",
+  "scripts": {
+    "release": "pnpm exec ts-node-esm ./scripts/run-semantic-release.mts",
+    "bump-version": "node ./scripts/bump-version.js"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/commit-analyzer": "11.1.0",
+    "@semantic-release/exec": "6.0.3",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/github": "9.0.2",
+    "@semantic-release/release-notes-generator": "12.1.0",
+    "semantic-release": "23.0.0",
+    "ts-node": "10.9.2",
+    "typescript": "5.6.3"
+  }
+}

release.config.mts

@@ -0,0 +1,33 @@
+import type { Options } from "semantic-release";
+
+/** Semantic-release configuration using pnpm and Gradle version bumping. */
+const config: Options = {
+  branches: ["main", "master"],
+  tagFormat: "v${version}",
+  plugins: [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/changelog",
+      {
+        changelogFile: "CHANGELOG.md"
+      }
+    ],
+    [
+      "@semantic-release/exec",
+      {
+        prepareCmd: "pnpm run bump-version ${nextRelease.version}"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        assets: ["CHANGELOG.md", "build.gradle.kts"],
+        message: "chore(release): ${nextRelease.version}\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github"
+  ]
+};
+
+export default config;

scripts/bump-version.js

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+
+/**
+ * Replace the Gradle project version in build.gradle.kts with the provided value.
+ * Used by semantic-release via @semantic-release/exec.
+ */
+const fs = require("fs");
+const path = require("path");
+
+const [, , nextVersion] = process.argv;
+
+if (!nextVersion) {
+  console.error("No version supplied to bump-version script.");
+  process.exit(1);
+}
+
+const gradleFile = path.join(__dirname, "..", "build.gradle.kts");
+const fileContent = fs.readFileSync(gradleFile, "utf8");
+const versionPattern = /(^\s*version\s*=\s*")[^"]+(")/m;
+
+if (!versionPattern.test(fileContent)) {
+  console.error(`Could not find version declaration in ${gradleFile}`);
+  process.exit(1);
+}
+
+const updatedContent = fileContent.replace(versionPattern, `$1${nextVersion}$2`);
+fs.writeFileSync(gradleFile, updatedContent, "utf8");
+console.log(`Set project version to ${nextVersion}`);

scripts/run-semantic-release.mts

@@ -0,0 +1,28 @@
+import semanticRelease from "semantic-release";
+import config from "../release.config.mts";
+
+/**
+ * Programmatic entrypoint so we can keep the release config in TypeScript (.mts).
+ */
+async function main() {
+  const result = await semanticRelease(config);
+
+  if (!result) {
+    console.log("No release published.");
+    return;
+  }
+
+  const { lastRelease, nextRelease, releases } = result;
+  console.log(
+    `Published ${nextRelease.type} release version ${nextRelease.version} ` +
+      `(previous ${lastRelease ? lastRelease.version : "none"})`
+  );
+  releases.forEach((release) => {
+    console.log(` - ${release.name} @ ${release.url}`);
+  });
+}
+
+main().catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "strict": false,
+    "skipLibCheck": true
+  },
+  "include": ["release.config.mts", "scripts/**/*.mts"]
+}