docker.yml

name: Build Docker image

on:
  workflow_call:
    inputs:
      uploadImageAsTarball:
        description: 'uploads the Docker image additionally as a tarball'
        required: false
        default: false
        type: boolean
      platforms:
        description: 'platforms for docker build step'
        required: false
        default: ''
        type: string
      debug:
        description: 'include debug symbols in built image'
        required: false
        default: false
        type: boolean
      uploadToDockerHub:
        description: 'upload image to DockerHub'
        required: false
        default: false
        type: boolean

  workflow_dispatch:
    inputs:
      debug:
        description: 'include debug symbols in built image'
        required: false
        default: false
        type: boolean
      uploadToDockerHub:
        description: 'upload image to DockerHub'
        required: false
        default: false
        type: boolean

env:
  GHCR_REGISTRY: 'ghcr.io'
  REPOSITORY_OWNER: ${{ github.repository_owner }}
  GHCR_REGISTRY_USERNAME: ${{ github.actor }}
  GHCR_REGISTRY_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
  build-and-push-image:
    runs-on: ubuntu-latest
    timeout-minutes: ${{ inputs.debug && 140 || 70 }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      # Setup caching
      - name: Set up QEMU dependency
        uses: docker/setup-qemu-action@v2

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2

      - name: Log in to the Container registry
        uses: docker/login-action@v2
        with:
          registry: ${{ env.GHCR_REGISTRY }}
          username: ${{ env.GHCR_REGISTRY_USERNAME }}
          password: ${{ env.GHCR_REGISTRY_TOKEN }}

      - name: Extract image name
        # Set repository name as image name
        run: |
          echo "IMAGE_NAME=${GITHUB_REPOSITORY#$GITHUB_REPOSITORY_OWNER/}" >> $GITHUB_ENV

      - name: Print image names
        run: |
          echo ${{ inputs.uploadToDockerHub && format('restatedev/{0}', env.IMAGE_NAME) || '' }}

      - name: Extract metadata (tags, labels) for Docker
        id: meta
        uses: docker/metadata-action@v4
        with:
          images: | 
            ${{ env.GHCR_REGISTRY }}/${{ env.REPOSITORY_OWNER }}/${{ env.IMAGE_NAME }}
            ${{ inputs.uploadToDockerHub && format('{0}/{1}', env.REPOSITORY_OWNER, env.IMAGE_NAME) || '' }}

          # Note: We need this to generate the latest tag until we have a first stable release.
          # Check https://github.com/docker/metadata-action/issues/34
          flavor: |
            latest=true
            ${{ inputs.debug && 'prefix=debug-,onlatest=true' || '' }}
          tags: |
            type=ref,event=branch
            type=semver,pattern={{version}}

      - name: Build${{inputs.uploadImageAsTarball != true && ' and push ' || ' '}}Docker image
        id: build
        uses: docker/build-push-action@v3
        with:
          context: .
          file: "docker/Dockerfile"
          push: ${{ inputs.uploadImageAsTarball != true }}
          tags: ${{ steps.meta.outputs.tags }}
          load: ${{ inputs.uploadImageAsTarball == true }}
          labels: ${{ steps.meta.outputs.labels }}
          platforms: ${{ inputs.platforms || 'linux/arm64,linux/amd64' }}
          build-args: |
            CARGO_PROFILE_RELEASE_DEBUG=${{ inputs.debug }}
          cache-from: type=gha,scope=${{ github.workflow }}
          cache-to: type=gha,mode=max,scope=${{ github.workflow }}

      - name: Save docker image as tar
        if: ${{ inputs.uploadImageAsTarball }}
        run: |
          docker save -o restate.tar ${{ steps.build.outputs.imageid }}

      - name: Upload docker image tar as artifact
        if: ${{ inputs.uploadImageAsTarball }}
        uses: actions/upload-artifact@v3
        with:
          name: restate.tar
          path: restate.tar
          retention-days: 1
          if-no-files-found: error

      # Even if uploadImageAsTarball, push main images
      # This won't actually build again, it'll just use cache
      - name: Push Docker image
        if: ${{ inputs.uploadImageAsTarball && github.ref == 'refs/heads/main' }}
        uses: docker/build-push-action@v3
        with:
          context: .
          file: "docker/Dockerfile"
          push: true
          tags: ${{ steps.meta.outputs.tags }}
          load: false
          labels: ${{ steps.meta.outputs.labels }}
          # ignore inputs.platforms as we always need to push both arm64 and amd64 docker images
          platforms: 'linux/arm64,linux/amd64'
          build-args: |
            CARGO_PROFILE_RELEASE_DEBUG=${{ inputs.debug }}
          cache-from: type=gha,scope=${{ github.workflow }}
          cache-to: type=gha,mode=max,scope=${{ github.workflow }}