Add CD and improve Actions caching

Author: fr1kin

.github/workflows/continuous_integration.yml

@@ -2,6 +2,10 @@ name: CI
 
 on:
   push:
+    branches:
+      - 'master'
+    tags:
+      - 'v*'
   pull_request:
 
 jobs:
@@ -16,6 +20,7 @@ jobs:
           path: |
             ~/.gradle/caches/modules-2
             ~/.gradle/wrapper/dists
+            ./.gradle/paperweight_cache
           key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle.kts', '**/gradle.properties', '**/gradle/wrapper/gradle-wrapper.properties') }}
           restore-keys: |
             ${{ runner.os }}-gradle-
@@ -29,10 +34,10 @@ jobs:
           sudo rm -f ~/.gradle/caches/modules-2/modules-2.lock
           sudo rm -f ~/.gradle/caches/modules-2/gc.properties
 
-# TODO:
-#      - name: Upload the built artifact
-#        uses: actions/upload-artifact@v2
-#        with:
-#          name: ${{ steps.exec.outputs.jar }}
-#          path: build/libs/${{ steps.exec.outputs.jar }}
-#          if-no-files-found: error
+      - name: Create release if this is a tagged workflow
+        uses: ncipollo/release-action@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          artifacts: build/libs/${{ steps.exec.outputs.paperclip }}
+          name: PaperX ${{ steps.exec.outputs.version }}
+          token: ${{ secrets.GITHUB_TOKEN }}

build.gradle.kts

@@ -2,10 +2,19 @@ import io.papermc.paperweight.util.constants.PAPERCLIP_CONFIG
 
 plugins {
   java
+  id("com.palantir.git-version") version "0.12.3"
   id("com.github.johnrengelman.shadow") version "7.1.1"
   id("io.papermc.paperweight.patcher") version "1.3.4"
 }
 
+val versionDetails: groovy.lang.Closure<com.palantir.gradle.gitversion.VersionDetails> by extra
+val git = versionDetails()
+
+group = "dev.fiki.paperx"
+version = "${providers.gradleProperty("mcVersion").get()}-${git.lastTag.substring(1)}.r${git.commitDistance}"
+
+val isCiBuilding = System.getenv()["CI"] == "true"
+
 repositories {
   mavenCentral()
   maven("https://papermc.io/repo/repository/maven-public/") {
@@ -64,3 +73,14 @@ paperweight {
     }
   }
 }
+
+val actionsTask by tasks.register("createGitHubActionsVars") {
+  onlyIf { isCiBuilding }
+  doFirst {
+    println("::set-output name=paperclip::${tasks.createReobfPaperclipJar.get().outputZip.get().asFile.name}")
+    println("::set-output name=bundler::${tasks.createReobfBundlerJar.get().outputZip.get().asFile.name}")
+    println("::set-output name=version::${project.version}")
+  }
+}
+
+tasks.createReobfPaperclipJar { finalizedBy(actionsTask) }

docker-compose.ci.yml

@@ -5,7 +5,6 @@ services:
     build:
       context: .
       dockerfile: ./Dockerfile
-    container_name: jdk-slim-git
     environment:
       - CI=${CI:-}
     volumes:
@@ -19,14 +18,13 @@ services:
       - .git/:/opt/build/.git/:ro
       # paperweight cache contains files that save the absolute path,
       # so we create a special volume to cache this directory
-      - paperweight_cache:/opt/build/.gradle/caches/paperweight/
+      # NOTE: a named volume would be better for this, but github actions does
+      # not allow you to cache /var/lib/docker/volumes
+      - ./.gradle/paperweight_cache/:/opt/build/.gradle/caches/paperweight/:Z
       # mount working directory
       - ./:/opt/build:Z
     working_dir: /opt/build
     # these two gradle tasks must be run independently, otherwise it will fail
     command: bash -c 'set -x
-               && ./gradlew --no-daemon applyPatches --stacktrace
-               && ./gradlew --no-daemon createReobfPaperclipJar --stacktrace'
-
-volumes:
-  paperweight_cache:
+      && ./gradlew --no-daemon applyPatches --stacktrace
+      && ./gradlew --no-daemon createReobfPaperclipJar --stacktrace'

gradle.properties

@@ -1,6 +1,3 @@
-group=dev.fiki.paperx
-version=1.18.1-R0.1-SNAPSHOT
-
 mcVersion=1.18.1
 packageVersion=1_18_R1
 paperRef=a8f2d6749189f58b131fb077b7961b31df5f8005

scripts/cibuild

@@ -17,6 +17,10 @@ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
   if [[ "${1:-}" == "--help" ]]; then
     usage
   else
+    # create .gradle with correct user permissions
+    # docker daemon may otherwise create this directory with root ownership
+    mkdir -p .gradle
+
     # if mounting the hosts cache folder, gradle inside the container will try and
     # acquire a file lock that the host machine may already be holding. this will
     # result in the container hanging indefinitely. stopping any existing daemons