Merge pull request #49 from butaneprotocol/cross-compilation

feat: cross-compile the oracle outside of docker

Author: SupernaviX

Diff for: .github/workflows/docker.yml

@@ -8,7 +8,17 @@ on:
 jobs:
   push_to_registry:
     name: Push Docker image to Docker Hub
-    runs-on: "ubuntu-20.04"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: "ubuntu-22.04"
+            platform: linux/amd64
+            rust_target: x86_64-unknown-linux-gnu
+          - os: "ubuntu-22.04"
+            platform: linux/arm64
+            rust_target: aarch64-unknown-linux-gnu
+
     permissions:
       packages: write
       contents: read
@@ -34,26 +44,20 @@ jobs:
         with:
           images: sundaeswap/butane-oracle
 
-      - name: Cargo Cache
+      - name: Install ARM toolchain
+        if: matrix.rust_target == 'aarch64-unknown-linux-gnu'
+        run: |
+          rustup target install aarch64-unknown-linux-gnu
+          sudo apt install gcc-aarch64-linux-gnu
+
+      - name: Rust Cache
         id: cache
-        uses: actions/cache@v4
+        uses: Swatinem/rust-cache@v2
         with:
-          path: |
-            cargo-registry-cache
-            sccache-cache
-          key: ${{ runner.os }}-cargo-cache-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-cargo-cache
+          prefix-key: ${{ matrix.rust_target }}
 
-      - name: inject cargo caches into docker
-        uses: reproducible-containers/buildkit-cache-dance@5b6db76d1da5c8b307d5d2e0706d266521b710de # v3.1.2
-        with:
-          cache-map: |
-            {
-              "cargo-registry-cache": "/usr/local/cargo/registry",
-              "sccache-cache": "/sccache"
-            }
-          skip-extraction: ${{ steps.cache.outputs.cache-hit }}
+      - name: Compile
+        run: cargo build --release --target ${{ matrix.rust_target }}
 
       - name: Build and push Docker image
         id: push
@@ -62,8 +66,10 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
           context: .
-          file: ./Dockerfile
+          file: ./prebuilt.Dockerfile
           push: true
-          platforms: "linux/amd64,linux/arm64"
+          platforms: ${{ matrix.platform }}
+          build-args: |
+            RUST_TARGET=${{ matrix.rust_target }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

Diff for: .github/workflows/refresh-docker-cache.yml

@@ -10,7 +10,17 @@ on:
 jobs:
   build_image:
     name: Build Docker image
-    runs-on: "ubuntu-20.04"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: "ubuntu-22.04"
+            platform: linux/amd64
+            rust_target: x86_64-unknown-linux-gnu
+          - os: "ubuntu-22.04"
+            platform: linux/arm64
+            rust_target: aarch64-unknown-linux-gnu
+
     permissions:
       contents: read
     steps:
@@ -27,26 +37,20 @@ jobs:
         with:
           images: sundaeswap/butane-oracle
 
-      - name: Cargo Cache
+      - name: Install ARM toolchain
+        if: matrix.rust_target == 'aarch64-unknown-linux-gnu'
+        run: |
+          rustup target install aarch64-unknown-linux-gnu
+          sudo apt install gcc-aarch64-linux-gnu
+
+      - name: Rust Cache
         id: cache
-        uses: actions/cache@v4
+        uses: Swatinem/rust-cache@v2
         with:
-          path: |
-            cargo-registry-cache
-            sccache-cache
-          key: ${{ runner.os }}-cargo-cache-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-cargo-cache
-  
-      - name: inject cargo caches into docker
-        uses: reproducible-containers/buildkit-cache-dance@5b6db76d1da5c8b307d5d2e0706d266521b710de # v3.1.2
-        with:
-          cache-map: |
-            {
-              "cargo-registry-cache": "/usr/local/cargo/registry",
-              "sccache-cache": "/sccache"
-            }
-          skip-extraction: ${{ steps.cache.outputs.cache-hit }}
+          prefix-key: ${{ matrix.rust_target }}
+
+      - name: Compile
+        run: cargo build --release --target ${{ matrix.rust_target }}
 
       - name: Build Docker image
         id: build
@@ -55,8 +59,10 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
           context: .
-          file: ./Dockerfile
+          file: ./prebuilt.Dockerfile
           outputs: type=image
-          platforms: "linux/amd64,linux/arm64"
+          platforms: ${{ matrix.platform }}
+          build-args: |
+            RUST_TARGET=${{ matrix.rust_target }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

Diff for: prebuilt.Dockerfile

@@ -0,0 +1,8 @@
+# GitHub Actions doesn't have free ARM runners for private repos.
+# Until we can use that, build the oracle from outside of docker via cross-compilation,
+# so that we don't do any expensive work inside of an emulated OS.
+FROM alpine
+ARG RUST_TARGET
+WORKDIR /app
+COPY target/${RUST_TARGET}/release/oracles /app/
+CMD ["./oracles"]