Update build.yml workflow to cross-compile linux binaries for `x86_…

…64` and `aarch64` (#140) * Update the build.yml workflow to cross-compile linux binaries for x86_64 and aarch64. * Change the Dockerfile to multi-stage for use with docker buildx.
coverallsapp · Aug 20, 2024 · 04f050e · 04f050e
1 parent 75828ec
commit 04f050e
Show file tree

Hide file tree

Showing 2 changed files with 127 additions and 26 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -12,11 +12,12 @@ permissions:
   contents: write
 
 jobs:
+  # Build the Windows binary
   build-windows:
     runs-on: windows-2022
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Crystal
         uses: crystal-lang/install-crystal@v1
@@ -50,61 +51,122 @@ jobs:
           tar -acf coveralls-windows.zip coveralls.exe
 
       - name: Upload exe
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: coveralls-windows.exe
           path: dist/coveralls.exe
           if-no-files-found: error
 
       - name: Upload zip
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: coveralls-windows.zip
           path: dist/coveralls-windows.zip
           if-no-files-found: error
 
+  # Build the Linux binaries for multiple architectures
   build-linux:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Install Crystal
-        uses: crystal-lang/install-crystal@v1
-        with:
-          crystal: 1.13.1
+      - name: Set up Docker BuildX
+        run: |
+          docker run --rm --privileged docker/binfmt:a7996909642ee92942dcd6cff44b9b95f08dad64
+          docker buildx create --use
+
+      - name: Build x86_64 binary
+        run: |
+          docker buildx build \
+            --no-cache \
+            --platform linux/amd64 \
+            --build-arg CRYSTAL_VERSION=1.13.1 \
+            --target x86_64_binary \
+            --output type=local,dest=./dist .
+
+      - name: Build aarch64 binary
+        run: |
+          docker buildx build \
+            --no-cache \
+            --platform linux/arm64 \
+            --build-arg CRYSTAL_VERSION=1.13.1 \
+            --target aarch64_binary \
+            --output type=local,dest=./dist .
+
+      - name: (Debug) Check contents of dist directory
+        run: |
+          echo "Contents of dist directory:"
+          ls -lh ./dist/
+          echo "Detailed contents of dist directory:"
+          find ./dist/ -type f -exec ls -lh {} \;
 
-      - name: Build (Linux)
-        run: make release_linux
+      - name: Rename and prepare artifacts
+        run: |
+          cd dist
+          cp coveralls-linux-x86_64 coveralls-linux  # Create the "generic" linux binary for backward compatibility
+          tar -czf coveralls-linux.tar.gz coveralls-linux
+          tar -czf coveralls-linux-x86_64.tar.gz coveralls-linux-x86_64
+          tar -czf coveralls-linux-aarch64.tar.gz coveralls-linux-aarch64
 
-      - name: Upload binary
-        uses: actions/upload-artifact@v3
+      - name: Upload generic linux binary (x86_64)
+        uses: actions/upload-artifact@v4
         with:
           name: coveralls-linux
-          path: dist/coveralls
+          path: dist/coveralls-linux
           if-no-files-found: error
 
-      - name: Upload tar.gz
-        uses: actions/upload-artifact@v3
+      - name: Upload generic linux (x86_64) tar.gz archive
+        uses: actions/upload-artifact@v4
         with:
           name: coveralls-linux.tar.gz
           path: dist/coveralls-linux.tar.gz
           if-no-files-found: error
 
+      - name: Upload x86_64-specific binary
+        uses: actions/upload-artifact@v4
+        with:
+          name: coveralls-linux-x86_64
+          path: dist/coveralls-linux-x86_64
+          if-no-files-found: error
+
+      - name: Upload x86_64-specific tar.gz archive
+        uses: actions/upload-artifact@v4
+        with:
+          name: coveralls-linux-x86_64.tar.gz
+          path: dist/coveralls-linux-x86_64.tar.gz
+          if-no-files-found: error
+
+      - name: Upload aarch64 binary
+        uses: actions/upload-artifact@v4
+        with:
+          name: coveralls-linux-aarch64
+          path: dist/coveralls-linux-aarch64
+          if-no-files-found: error
+
+      - name: Upload aarch64 tar.gz archive
+        uses: actions/upload-artifact@v4
+        with:
+          name: coveralls-linux-aarch64.tar.gz
+          path: dist/coveralls-linux-aarch64.tar.gz
+          if-no-files-found: error
+
+  # Create a GitHub release and attach built artifacts
   release:
     runs-on: ubuntu-latest
     needs: [build-windows, build-linux]
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Fetch tags
         run: git fetch --force --tags
 
-      - uses: actions/download-artifact@v3
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
         with:
           path: artifacts/
 
@@ -113,33 +175,36 @@ jobs:
           mkdir release/
           find artifacts/ -type f -exec cp \{} release/ \;
           cd release/
-          mv coveralls coveralls-linux
           mv coveralls.exe coveralls-windows.exe
           sha256sum * > coveralls-checksums.txt
 
-      - name: Create Github release
+      - name: Create GitHub release
         env:
           TAG: ${{ github.ref }}
           GH_TOKEN: ${{ github.token }}
         run: >
           cd release/;
           gh release create ${TAG}
-          'coveralls-linux#coveralls-linux'
-          'coveralls-linux.tar.gz#coveralls-linux.tar.gz'
+          'coveralls-linux#coveralls-linux'  # Upload generic linux binary for backawrds compatibility with github-action and orb
+          'coveralls-linux.tar.gz#coveralls-linux.tar.gz'  # Upload generic linux tar.gz archive for backwards compatibility with github-action and orb
+          'coveralls-linux-x86_64#coveralls-linux-x86_64'
+          'coveralls-linux-x86_64.tar.gz#coveralls-linux-x86_64.tar.gz'
+          'coveralls-linux-aarch64#coveralls-linux-aarch64'
+          'coveralls-linux-aarch64.tar.gz#coveralls-linux-aarch64.tar.gz'
           'coveralls-windows.exe#coveralls-windows.exe'
           'coveralls-windows.zip#coveralls-windows.zip'
           'coveralls-checksums.txt#coveralls-checksums.txt'
           --generate-notes
 
+  # Update the Homebrew formula for MacOS releases
   homebrew:
     runs-on: ubuntu-latest
     needs: [release]
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
     steps:
       - name: Update Homebrew formula
-        uses: dawidd6/action-homebrew-bump-formula@v3
+        uses: dawidd6/action-homebrew-bump-formula@v4
         with:
           tap: coverallsapp/coveralls
           formula: coveralls
           token: ${{ secrets.HOMEBREW_TOKEN }}
-
diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,40 @@
-ARG CRYSTAL_VERSION
-FROM crystallang/crystal:${CRYSTAL_VERSION}-alpine
+# ARG to specify Crystal version and base image tag
+ARG CRYSTAL_VERSION=1.13.1
+ARG BASE_IMAGE_TAG=ubuntu-22.04
 
-RUN apk add xz-dev xz-static libxml2-dev libxml2-static sqlite-dev sqlite-static
+# Stage 1: Build for x86_64
+FROM 84codes/crystal:${CRYSTAL_VERSION}-${BASE_IMAGE_TAG} AS builder-x86_64
+WORKDIR /app
+RUN git clone https://github.com/coverallsapp/coverage-reporter.git .
+# Install only the necessary dependencies, skipping ameba and kcov
+RUN sed -i '/ameba/d' shard.yml \
+    && sed -i '/crystal-kcov/d' shard.yml \
+    && shards install --ignore-crystal-version \
+    && mkdir -p /app/bin \
+    && crystal build --release src/coverage_reporter.cr -o /app/bin/coveralls-linux-x86_64
+
+# Stage 2: Build for aarch64
+FROM 84codes/crystal:${CRYSTAL_VERSION}-${BASE_IMAGE_TAG} AS builder-aarch64
+WORKDIR /app
+COPY --from=builder-x86_64 /app /app
+
+# Install dependencies. Ensure ameba and kcov are not present
+RUN sed -i '/ameba/d' shard.yml \
+    && sed -i '/crystal-kcov/d' shard.yml \
+    && rm -rf lib/* \
+    && rm -rf .shards \
+    && shards install --ignore-crystal-version \
+    && mkdir -p /app/bin \
+    && crystal build --release src/coverage_reporter.cr -o /app/bin/coveralls-linux-aarch64
+
+# Stage 3a: Export Binary for x86_64
+FROM scratch AS x86_64_binary
+COPY --from=builder-x86_64 /app/bin/coveralls-linux-x86_64 /
+
+# Stage 3b: Export Binary for aarch64
+FROM scratch AS aarch64_binary
+COPY --from=builder-aarch64 /app/bin/coveralls-linux-aarch64 /
+
+# Stage 4: Final stage to create a generic binary for backward compatibility
+FROM scratch AS final
+COPY --from=x86_64_binary /coveralls-linux-x86_64 /coveralls-linux