hermitize (#163)

* init hermit. hermit installed openjdk@11 and gradle-8.2 (current version per running ./gradlew --version). replaced gradlew wrapper validator action with init hermit step to publish ci and docs yaml

* using public hermit version

* removing gradle wrapper directory

* writing a small readme about hermit

* addressing code review comments

* adding a section on readme about hermit package management

* reverting to current version of tbdex submodule commit

.github/workflows/ci.yaml

@@ -20,7 +20,9 @@ jobs:
         uses: actions/checkout@v2
         with:
           submodules: "true"
-      - uses: gradle/wrapper-validation-action@v1
+      # https://cashapp.github.io/hermit/usage/ci/
+      - name: Init Hermit
+        uses: cashapp/activate-hermit@v1
       - uses: actions/setup-java@v1
         with:
           java-version: 17
@@ -30,7 +32,7 @@ jobs:
           key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle.kts') }}-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}-${{ hashFiles('**/versions.properties') }}
 
       - name: Run Gradle Tasks
-        run: ./gradlew build koverXmlReport
+        run: gradle build koverXmlReport
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v3

.github/workflows/docs.yaml

@@ -32,7 +32,9 @@ jobs:
         os: [ ubuntu-latest ]
     steps:
       - uses: actions/checkout@v3
-      - uses: gradle/wrapper-validation-action@v1
+      # https://cashapp.github.io/hermit/usage/ci/
+      - name: Init Hermit
+        uses: cashapp/activate-hermit@v1
       - uses: actions/setup-java@v1
         with:
           java-version: 17
@@ -42,7 +44,7 @@ jobs:
           key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle.kts') }}-${{ hashFiles('**/gradle/wrapper/gradle-wrapper.properties') }}-${{ hashFiles('**/versions.properties') }}
 
       - name: Build Docs
-        run: ./gradlew dokkaHtmlMultiModule
+        run: gradle dokkaHtmlMultiModule
 
       - name: Setup Pages
         uses: actions/configure-pages@v3

.github/workflows/publish.yaml

@@ -15,7 +15,9 @@ jobs:
       - uses: actions/checkout@v4
         with:
           submodules: true
-      - uses: gradle/wrapper-validation-action@v1
+      # https://cashapp.github.io/hermit/usage/ci/
+      - name: Init Hermit
+        uses: cashapp/activate-hermit@v1
       - name: Set up Java
         uses: actions/setup-java@v3
         with:
@@ -29,9 +31,9 @@ jobs:
       - name: Sonatype Publish Close And Release
         run: |
           if [ -n "${{ github.event.inputs.version }}" ]; then
-            ./gradlew -Pversion=${{ github.event.inputs.version }} publishToSonatype closeAndReleaseSonatypeStagingRepository
+            gradle -Pversion=${{ github.event.inputs.version }} publishToSonatype closeAndReleaseSonatypeStagingRepository
           else
-            ./gradlew -Pversion=$(echo "${{ github.ref_name }}" | cut -c2-) publishToSonatype closeAndReleaseSonatypeStagingRepository
+            gradle -Pversion=$(echo "${{ github.ref_name }}" | cut -c2-) publishToSonatype closeAndReleaseSonatypeStagingRepository
           fi
         env:
           ORG_GRADLE_PROJECT_signingKey: ${{ secrets.ORG_GRADLE_PROJECT_SIGNINGKEY }}

README.md

@@ -12,6 +12,17 @@ This repo contains 2 jvm packages:
 
 tbdex sdk is consumable through Maven Central but some additional repositories are needed for transitive dependencies currently: :
 
+# Hermit
+This project uses hermit to manage tooling like gradle or openjdk. See [this page](https://cashapp.github.io/hermit/usage/get-started/) to set up Hermit on your machine.
+After installing hermit and activating it, you should be able to just run `gradle clean build` to build the project locally.
+
+Currently, we have these packages installed via Hermit (can also view by checking out `hermit status`:
+- gradle-8.2 
+- openjdk-11.0.10_9
+
+You can run `hermit upgrade {package}` to upgrade an existing package, or `hermit install {package}` to install a new package. 
+Please see [Hermit package management page](https://cashapp.github.io/hermit/usage/management/) for more details.
+
 ## Gradle
 ```kotlin
 repositories {
@@ -66,7 +77,7 @@ dependencies {
   <summary>Expand for complete mvn pom.xml example using kotlin</summary>
 
   pom.xml:
-  ```
+```xml
 <?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://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -256,9 +267,6 @@ fun main() {
 }
 ```
 
-
-
-
 # Development
 
 ## JSON Schemas
@@ -273,8 +281,6 @@ If you've already cloned the repo without `--recurse-submodules`, you can do the
 git submodule update --init
 ```
 
-copying the schemas and test vectors into the protocol package's `resources` directory can be done by running `./gradlew syncSchemas` and `./gradlew syncTestVectors` respectively.
-
 # Other Docs
 
 * [Guidelines](./CONVENTIONS.md)

bin/.gradle-8.2.pkg

@@ -0,0 +1 @@
+hermit

bin/.openjdk-11.0.10_9.pkg

@@ -0,0 +1 @@
+hermit

bin/README.hermit.md

@@ -0,0 +1,7 @@
+# Hermit environment
+
+This is a [Hermit](https://github.com/cashapp/hermit) bin directory.
+
+The symlinks in this directory are managed by Hermit and will automatically
+download and install Hermit itself as well as packages. These packages are
+local to this environment.

bin/activate-hermit

@@ -0,0 +1,21 @@
+#!/bin/bash
+# This file must be used with "source bin/activate-hermit" from bash or zsh.
+# You cannot run it directly
+#
+# THIS FILE IS GENERATED; DO NOT MODIFY
+
+if [ "${BASH_SOURCE-}" = "$0" ]; then
+  echo "You must source this script: \$ source $0" >&2
+  exit 33
+fi
+
+BIN_DIR="$(dirname "${BASH_SOURCE[0]:-${(%):-%x}}")"
+if "${BIN_DIR}/hermit" noop > /dev/null; then
+  eval "$("${BIN_DIR}/hermit" activate "${BIN_DIR}/..")"
+
+  if [ -n "${BASH-}" ] || [ -n "${ZSH_VERSION-}" ]; then
+      hash -r 2>/dev/null
+    fi
+
+    echo "Hermit environment $("${HERMIT_ENV}"/bin/hermit env HERMIT_ENV) activated"
+fi

bin/gradle

@@ -0,0 +1 @@
+.gradle-8.2.pkg

bin/hermit

@@ -0,0 +1,43 @@
+#!/bin/bash
+#
+# THIS FILE IS GENERATED; DO NOT MODIFY
+
+set -eo pipefail
+
+export HERMIT_USER_HOME=~
+
+if [ -z "${HERMIT_STATE_DIR}" ]; then
+  case "$(uname -s)" in
+  Darwin)
+    export HERMIT_STATE_DIR="${HERMIT_USER_HOME}/Library/Caches/hermit"
+    ;;
+  Linux)
+    export HERMIT_STATE_DIR="${XDG_CACHE_HOME:-${HERMIT_USER_HOME}/.cache}/hermit"
+    ;;
+  esac
+fi
+
+export HERMIT_DIST_URL="${HERMIT_DIST_URL:-https://github.com/cashapp/hermit/releases/download/stable}"
+HERMIT_CHANNEL="$(basename "${HERMIT_DIST_URL}")"
+export HERMIT_CHANNEL
+export HERMIT_EXE=${HERMIT_EXE:-${HERMIT_STATE_DIR}/pkg/hermit@${HERMIT_CHANNEL}/hermit}
+
+if [ ! -x "${HERMIT_EXE}" ]; then
+  echo "Bootstrapping ${HERMIT_EXE} from ${HERMIT_DIST_URL}" 1>&2
+  INSTALL_SCRIPT="$(mktemp)"
+  # This value must match that of the install script
+  INSTALL_SCRIPT_SHA256="180e997dd837f839a3072a5e2f558619b6d12555cd5452d3ab19d87720704e38"
+  if [ "${INSTALL_SCRIPT_SHA256}" = "BYPASS" ]; then
+    curl -fsSL "${HERMIT_DIST_URL}/install.sh" -o "${INSTALL_SCRIPT}"
+  else
+    # Install script is versioned by its sha256sum value
+    curl -fsSL "${HERMIT_DIST_URL}/install-${INSTALL_SCRIPT_SHA256}.sh" -o "${INSTALL_SCRIPT}"
+    # Verify install script's sha256sum
+    openssl dgst -sha256 "${INSTALL_SCRIPT}" | \
+      awk -v EXPECTED="$INSTALL_SCRIPT_SHA256" \
+      '$2!=EXPECTED {print "Install script sha256 " $2 " does not match " EXPECTED; exit 1}'
+  fi
+  /bin/bash "${INSTALL_SCRIPT}" 1>&2
+fi
+
+exec "${HERMIT_EXE}" --level=fatal exec "$0" -- "$@"

bin/jaotc

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jar

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jarsigner

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/java

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/javac

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/javadoc

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/javap

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jcmd

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jconsole

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jdb

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jdeprscan

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jdeps

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jfr

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jhsdb

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jimage

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jinfo

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jjs

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jlink

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jmap

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jmod

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jps

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jrunscript

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jshell

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jstack

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jstat

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/jstatd

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/keytool

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/pack200

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/rmic

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/rmid

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/rmiregistry

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/serialver

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

bin/unpack200

@@ -0,0 +1 @@
+.openjdk-11.0.10_9.pkg

build.gradle.kts

@@ -46,8 +46,8 @@ buildscript {
 }
 
 allprojects {
-
   group = "xyz.block"
+  tasks.findByName("wrapper")?.enabled = false
 
   configurations.all {
     /**