docker.yaml

name: Docker

# This will run when:
# - when new code is pushed to main/staging to push the tags
#   latest and develop
# - when a pull request is created and updated  to make sure the
#   Dockerfile is still valid.
# To be able to push to dockerhub, this execpts the following
# secrets to be set in the project:
# - DOCKERHUB_USERNAME : username that can push to the org
# - DOCKERHUB_PASSWORD : password asscoaited with the username
on:
  push:
    branches:
      - main
      - staging
      - expt
  pull_request:

# Certain actions will only run when this is the main repo.
env:
  MAIN_REPO: classtranscribe/WebAPI
  DOCKERHUB_ORG: classtranscribe

jobs:
  docker:
    runs-on: ubuntu-latest
    permissions:
      packages: write

    strategy:
      fail-fast: false
      matrix:
        name:
          - api
          - taskengine
          - pythonrpcserver
        include:
          - name: api
            FOLDER: "."
            DOCKERFILE: API.Dockerfile
            IMAGE: api
            PLATFORM: "linux/amd64,linux/arm64"
          - name: taskengine
            FOLDER: "."
            DOCKERFILE: TaskEngine.Dockerfile
            IMAGE: taskengine
            PLATFORM: "linux/amd64,linux/arm64"
          - name: pythonrpcserver
            FOLDER: "."
            DOCKERFILE: pythonrpcserver.Dockerfile
            IMAGE: pythonrpcserver
            PLATFORM: "linux/amd64"

    steps:
      - uses: actions/checkout@v2

      # calculate some variables that are used later
      - name: version
        run: |
          # find out what the BRANCH is, in case of a PR we will use the PR-<number>
          if [ "${{ github.event.release.target_commitish }}" != "" ]; then
            BRANCH="${{ github.event.release.target_commitish }}"
          elif [[ $GITHUB_REF =~ pull ]]; then
            BRANCH="$(echo $GITHUB_REF | sed 's#refs/pull/\([0-9]*\)/merge#PR-\1#')"
          else
            BRANCH=${GITHUB_REF##*/}
          fi

          # should we push to dockerhub, and is there a README
          DOCKERHUB_PUSH="false"
          DOCKERHUB_README="false"
          if [ "${{ github.repository }}" == "${{ env.MAIN_REPO }}" ]; then
            if [ "${{ secrets.DOCKERHUB_USERNAME }}" != "" -a "${{ secrets.DOCKERHUB_PASSWORD }}" != "" ]; then
              DOCKERHUB_PUSH="true"
              if [ -e "${{ matrix.FOLDER }}/README.md" ]; then
                DOCKERHUB_README="true"
              fi
            fi
          fi

          # calculate the version and all tags
          if [ "$BRANCH" == "main" ]; then
            tags="latest $(date +'%Y%m%d') ${BRANCH}-${{ github.run_number }}"
          else
            tags="${BRANCH} ${BRANCH}-${{ github.run_number }}"
          fi

          # create a list of all images to be pushed
          IMAGES=""
          for tag in ${tags}; do
            if [ "$DOCKERHUB_PUSH" == "true" ]; then
              IMAGES="${IMAGES}${{ env.DOCKERHUB_ORG }}/${{ matrix.IMAGE }}:${tag},"
            fi
            IMAGES="${IMAGES}ghcr.io/${{ github.repository_owner }}/${{ matrix.IMAGE }}:${tag},"
          done
          IMAGES="${IMAGES%,*}"

          # save the results in env
          echo "BRANCH=${BRANCH}"
          echo "DOCKERHUB_README=${DOCKERHUB_README}"
          echo "DOCKERHUB_PUSH=${DOCKERHUB_PUSH}"
          echo "IMAGES=${IMAGES}"

          echo "BRANCH=${BRANCH}" >> $GITHUB_ENV
          echo "DOCKERHUB_README=${DOCKERHUB_README}" >> $GITHUB_ENV
          echo "DOCKERHUB_PUSH=${DOCKERHUB_PUSH}" >> $GITHUB_ENV
          echo "IMAGES=${IMAGES}" >> $GITHUB_ENV

      # setup docker build
      - name: Set up QEMU
        uses: docker/setup-qemu-action@v2

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

      - name: Inspect Builder
        run: |
          echo "Name:      ${{ steps.buildx.outputs.name }}"
          echo "Endpoint:  ${{ steps.buildx.outputs.endpoint }}"
          echo "Status:    ${{ steps.buildx.outputs.status }}"
          echo "Flags:     ${{ steps.buildx.outputs.flags }}"
          echo "Platforms: ${{ steps.buildx.outputs.platforms }}"

      # login to registries
      - name: Login to DockerHub
        if: env.DOCKERHUB_PUSH == 'true'
        uses: docker/login-action@v2
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_PASSWORD }}

      - name: Login to GitHub Container Registry
        uses: docker/login-action@v2
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      # build the docker images
      - name: Build and push ${{ matrix.name }}
        uses: docker/build-push-action@v2
        with:
          push: true
          context: ${{ matrix.FOLDER }}
          file: ${{ matrix.DOCKERFILE }}
          platforms: ${{ matrix.PLATFORM }}
          cache-from: type=gha,scope=${{ matrix.name }}
          cache-to: type=gha,mode=max,scope=${{ matrix.name }}
          tags: ${{ env.IMAGES }}
          build-args: |
            BRANCH: ${{ env.BRANCH }}
            BUILDNUMBER=${{ github.run_number }}
            GITSHA1=${{ github.sha  }}

      # this will update the README of the dockerhub repo
      # - name: Docker Hub Description
      #   if: env.DOCKERHUB_README == 'true'
      #   uses: peter-evans/dockerhub-description@v2
      #   env:
      #     DOCKERHUB_USERNAME: ${{ secrets.DOCKERHUB_USERNAME }}
      #     DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
      #     DOCKERHUB_REPOSITORY: ${{ env.DOCKERHUB_ORG }}/extractors-${{ matrix.NAME }}
      #     README_FILEPATH: ${{ matrix.FOLDER }}/README.md