Merge pull request #44 from palantir/github-actions

GitHub actions

Author: daberkow

.circleci/config.yml

@@ -17,36 +17,11 @@ jobs:
           name: Copy Assets
           command: |
             cp ./build/libs/onb-classic-*-all.jar ~/assets-cache/onb-classic-all.jar
-      - run:
-          name: Get Version
-          command: |
-            onbVersion=$(./gradlew -q showVersion)
-            echo $onbVersion > ~/assets-cache/onbversion.txt
       - persist_to_workspace:
           root: ~/assets-cache
           paths:
             - ./*
 
-  deploy-snapshot:
-    docker: [{ image: 'cimg/openjdk:21.0' }]
-    steps:
-      - checkout
-      - attach_workspace:
-          at: ~/assets-cache
-      - run:
-          name: Publish snapshot
-          command: if [[ -z "$CIRCLE_PR_NUMBER" ]]; then ./scripts/publish.sh snapshot; else echo "Skipping...not from the official repo."; fi
-
-  deploy-release:
-    docker: [{ image: 'cimg/openjdk:21.0' }]
-    steps:
-      - checkout
-      - attach_workspace:
-          at: ~/assets-cache
-      - run:
-          name: Publish release
-          command: if [[ -z "$CIRCLE_PR_NUMBER" ]]; then ./scripts/publish.sh release; else echo "Skipping...not from the official repo."; fi
-
   circle-all:
     docker: [{ image: 'busybox:1.36.1@sha256:6d9ac9237a84afe1516540f40a0fafdc86859b2141954b4d643af7066d598b74' }]
     resource_class: small
@@ -58,18 +33,6 @@ workflows:
   build-and-deploy:
     jobs:
       - build
-      - deploy-snapshot:
-          requires:
-            - build
-          filters:
-            branches:
-              only: /^develop.*/
-      - deploy-release:
-          requires:
-            - build
-          filters:
-            branches:
-              only: /^release.*/
       - circle-all:
           requires: [ build ]
           filters: { tags: { only: /.*/ } }

.github/workflows/release.yml

@@ -0,0 +1,58 @@
+name: Build and Release
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on version tags like v1.0.0, v2.1.3, etc.
+  workflow_dispatch:  # Allow manual triggering
+
+permissions:
+  contents: write  # Required to create releases and upload assets
+
+jobs:
+  build-and-release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Full history needed for git-version plugin
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+          cache: 'gradle'
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew shadowJar
+
+      - name: Get version
+        id: version
+        run: |
+          VERSION=$(./gradlew -q showVersion)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          echo "Building version: $VERSION"
+
+      - name: Find JAR file
+        id: jar
+        run: |
+          JAR_FILE=$(find ./build/libs -name "onb-classic-*-all.jar" | head -n 1)
+          echo "jar_file=$JAR_FILE" >> $GITHUB_OUTPUT
+          echo "Found JAR: $JAR_FILE"
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: Release ${{ steps.version.outputs.version }}
+          draft: false
+          prerelease: false
+          generate_release_notes: true
+          files: |
+            ${{ steps.jar.outputs.jar_file }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -17,6 +17,10 @@ Docs: [Docs](https://palantir.github.io/onb-classic/), source in docs/source
 
 Releases: [Releases on Github](https://github.com/palantir/onb-classic/releases)
 
+**Platform Support**: Release JARs include JavaFX native libraries for Windows (x86-64), Linux (x86-64),
+and macOS (ARM64/Apple Silicon). Intel Macs and ARM Linux are not supported in releases;
+users on those platforms can [build from source for their architecture](https://palantir.github.io/onb-classic/development/index.html#building-for-different-platforms).
+
 ![ONB-Classic Booting](./docs/onb_booting.gif)
 
 ## Running
@@ -32,11 +36,6 @@ Releases: [Releases on Github](https://github.com/palantir/onb-classic/releases)
 The build will finish and put resources in "./build/libs/", onb-classic.jar has no dependencies included,
 while onb-classic-all.jar has all its dependencies bundled into the jar.
 
-## Open Source Plans
-
-1. Clean up code more
-  - replace all PUBLIC_URL_NEEDED
-
 ## Licenses
 
 This project is under Apache 2.0, some of the core TFTP files come from an old version of Apache Net Commons.

build.gradle

@@ -41,30 +41,124 @@ apply plugin: 'com.palantir.jdks.latest'
 group = 'com.palantir.onb'
 version gitVersion()
 
+def javafxVersion = "21.0.9"
+def javafxModules = ['base', 'controls', 'fxml', 'graphics']
+
+// Per-platform configs hold the classifier-specific native jars that get folded
+// into the shadow jar. Attributes are required: openjfx publishes Gradle Module
+// Metadata with multiple variants (winRuntime/linuxRuntime/macRuntime/etc.) and
+// without these, Gradle can't pick one and resolution fails with an ambiguity
+// error. The classifier in the coordinate pins the file *after* variant
+// selection; attributes drive the variant selection itself.
+//
+// Apple Silicon only on macOS. Intel Macs (pre-2020) are unsupported; users on
+// those machines can build from source against the :mac classifier themselves.
+configurations {
+    javafxWin {
+        attributes {
+            attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage, Usage.JAVA_RUNTIME))
+            attribute(OperatingSystemFamily.OPERATING_SYSTEM_ATTRIBUTE, objects.named(OperatingSystemFamily, 'windows'))
+            attribute(MachineArchitecture.ARCHITECTURE_ATTRIBUTE, objects.named(MachineArchitecture, 'x86-64'))
+        }
+    }
+    javafxLinux {
+        attributes {
+            attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage, Usage.JAVA_RUNTIME))
+            attribute(OperatingSystemFamily.OPERATING_SYSTEM_ATTRIBUTE, objects.named(OperatingSystemFamily, 'linux'))
+            attribute(MachineArchitecture.ARCHITECTURE_ATTRIBUTE, objects.named(MachineArchitecture, 'x86-64'))
+        }
+    }
+    javafxMacAarch64 {
+        attributes {
+            attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage, Usage.JAVA_RUNTIME))
+            attribute(OperatingSystemFamily.OPERATING_SYSTEM_ATTRIBUTE, objects.named(OperatingSystemFamily, 'macos'))
+            attribute(MachineArchitecture.ARCHITECTURE_ATTRIBUTE, objects.named(MachineArchitecture, 'aarch64'))
+        }
+    }
+}
+
+def addJavafx = { String classifier, String configName ->
+    javafxModules.each { m ->
+        dependencies.add(configName, "org.openjfx:javafx-${m}:${javafxVersion}:${classifier}")
+    }
+}
+addJavafx('win',         'javafxWin')
+addJavafx('linux',       'javafxLinux')
+addJavafx('mac-aarch64', 'javafxMacAarch64')
+
 jar {
     manifest {
         attributes 'Main-Class': 'com.palantir.onb.Core'
     }
 }
 
+shadowJar {
+    archiveClassifier.set('all')
+    manifest {
+        attributes 'Main-Class': 'com.palantir.onb.Core'
+    }
+    mergeServiceFiles()
+
+    // Reproducible builds: same git SHA -> byte-identical jar
+    preserveFileTimestamps = false
+    reproducibleFileOrder = true
+
+    // Bundle natives for every supported platform. The openjfx plugin is
+    // configured with `configuration = 'compileOnly'` below so runtimeClasspath
+    // does NOT contain host-arch natives — output is independent of build host.
+    configurations = [
+        project.configurations.runtimeClasspath,
+        project.configurations.javafxWin,
+        project.configurations.javafxLinux,
+        project.configurations.javafxMacAarch64,
+    ]
+}
+
+// Fail the build if shadowJar is missing natives for any supported platform.
+// Catches future regressions (renamed config, wrong classifier, etc.) at build
+// time rather than at a user's desktop.
+tasks.register('verifyShadowJarNatives') {
+    dependsOn shadowJar
+    def jarProvider = shadowJar.archiveFile
+    doLast {
+        def jar = jarProvider.get().asFile
+        def entries = new java.util.zip.ZipFile(jar).withCloseable { zf ->
+            zf.entries().collect { it.name }
+        }
+        def checks = [
+            win        : entries.any { it.endsWith('glass.dll') },
+            linux      : entries.any { it.endsWith('libglass.so') },
+            macAarch64 : entries.any { it.endsWith('libglass.dylib') },
+        ]
+        def missing = checks.findAll { !it.value }.collect { it.key }
+        if (missing) {
+            throw new GradleException("shadowJar is missing JavaFX natives for: ${missing}. " +
+                "Check the per-platform configurations and openjfx plugin setup.")
+        }
+        logger.lifecycle("shadowJar natives present for: ${checks.keySet().join(', ')}")
+    }
+}
+tasks.named('build') { dependsOn 'verifyShadowJarNatives' }
+
 java {
     modularity.inferModulePath = true
 }
 
 // Generate version.properties file from git tags
 tasks.register('generateVersionProperties') {
-    def outputDir = file("${buildDir}/generated/resources")
+    def outputDir = layout.buildDirectory.dir('generated/resources')
     outputs.dir outputDir
+    def versionString = project.version.toString()
     doLast {
-        outputDir.mkdirs()
-        def propsFile = file("${outputDir}/version.properties")
-        propsFile.text = "version=${project.version}\n"
+        def dir = outputDir.get().asFile
+        dir.mkdirs()
+        new File(dir, 'version.properties').text = "version=${versionString}\n"
     }
 }
 
 processResources {
     dependsOn generateVersionProperties
-    from("${buildDir}/generated/resources") {
+    from(layout.buildDirectory.dir('generated/resources')) {
         include 'version.properties'
     }
 }
@@ -114,12 +208,13 @@ dependencyUpdates {
     }
 }
 
+// `configuration = 'compileOnly'` keeps JavaFX natives off runtimeClasspath
+// so the shadow jar's contents are a pure function of the explicit per-platform
+// configs above — not of whatever host architecture happened to run gradle.
 javafx {
-    version = "21.0.9"
-    modules = [
-        'javafx.controls',
-        'javafx.fxml'
-    ]
+    version = javafxVersion
+    modules = ['javafx.controls', 'javafx.fxml']
+    configuration = 'compileOnly'
 }
 
 tasks.withType(Test) {
@@ -172,19 +267,20 @@ def tomcatVersion = '10.1.49'
 dependencies {
     implementation group: 'com.palantir.isofilereader', name: 'isofilereader', version: '0.6.2'
 
-    // For dependencies
     implementation 'com.google.code.gson:gson:2.13.2'
 
-    implementation group: 'org.apache.tomcat.embed', name: 'tomcat-embed-core', version: "$tomcatVersion"
+    implementation group: 'org.apache.tomcat.embed', name: 'tomcat-embed-core',   version: "$tomcatVersion"
     implementation group: 'org.apache.tomcat.embed', name: 'tomcat-embed-jasper', version: "$tomcatVersion"
-    implementation group: 'org.apache.tomcat', name: 'tomcat-jasper', version: "$tomcatVersion"
-    implementation group: 'org.apache.tomcat', name: 'tomcat-jasper-el', version: "$tomcatVersion"
-    implementation group: 'org.apache.tomcat', name: 'tomcat-jsp-api', version: "$tomcatVersion"
+    implementation group: 'org.apache.tomcat',       name: 'tomcat-jasper',       version: "$tomcatVersion"
+    implementation group: 'org.apache.tomcat',       name: 'tomcat-jasper-el',    version: "$tomcatVersion"
+    implementation group: 'org.apache.tomcat',       name: 'tomcat-jsp-api',      version: "$tomcatVersion"
 
     testImplementation('io.github.glytching:junit-extensions:2.6.0')
     testImplementation('org.hamcrest:hamcrest-integration:1.3')
     testImplementation(platform('org.junit:junit-bom:6.0.1'))
     testImplementation('org.junit.jupiter:junit-jupiter')
+
+    // JavaFX per-platform natives are wired up earlier via addJavafx(...).
 }
 
 test {

docs/source/development/index.rst

@@ -14,6 +14,36 @@ The following line in your .zshrc or .bashrc on Mac makes starting IntelliJ as a
 
     alias intellij="sudo ~/Applications/IntelliJ\ IDEA\ Ultimate.app/Contents/MacOS/idea"
 
+Building for Different Platforms
+---------------------------------
+
+By default, the universal JAR includes JavaFX native libraries for:
+
+- **Windows**: x86-64
+- **Linux**: x86-64
+- **macOS**: ARM64 (Apple Silicon)
+
+If you need to build for a different architecture (e.g., ARM64 Linux or Intel Mac), you can modify ``build.gradle``:
+
+1. Find the ``addJavafx`` calls near line 85:
+
+   .. code:: groovy
+
+       addJavafx('win',         'javafxWin')
+       addJavafx('linux',       'javafxLinux')
+       addJavafx('mac-aarch64', 'javafxMacAarch64')
+
+2. Change the classifier to match your platform:
+
+   - **Intel Mac**: ``'mac'`` instead of ``'mac-aarch64'``
+   - **ARM Linux**: ``'linux-aarch64'`` instead of ``'linux'``
+
+3. Update the corresponding configuration name in the ``shadowJar`` configurations list (around line 109).
+
+4. Update the ``verifyShadowJarNatives`` task (around line 120) to check for your platform's native library.
+
+Available JavaFX classifiers: ``win``, ``linux``, ``linux-aarch64``, ``mac``, ``mac-aarch64``
+
 General Design
 --------------
 

docs/source/overview.rst

@@ -6,7 +6,7 @@ ONB-Classic is a fork of the OpenNetBoot project that has been used at Palantir
 Availability
 ------------
 
-Releases are currently put on `Github <PUBLIC_URL_NEEDED>`_
+Releases are currently put on `Github <https://github.com/palantir/onb-classic/releases>`_
 
 Release Schedule
 ----------------