Merge pull request #2331 from keep-network/rfc-18/use-docker-build-publish-action

Switch to Docker's build-publish-action in GitHub Actions

In this PR we are switching the Go building workflow to Docker's official [Build and Publish Action](https://github.com/marketplace/actions/build-and-push-docker-images).

We were experiencing some issues with running out of disk space while using `satackey/action-docker-layer-caching`. It was happening because the cache size was incremented with each execution. During testing, it [grew up pretty quickly to 7 GB](https://github.com/keep-network/keep-core/runs/1880553919?check_suite_focus=true). There is an issue describing such a situation satackey/action-docker-layer-caching#55. I tried the proposed workarounds but was not satisfied with them.

According to [documentation](https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows#usage-limits-and-eviction-policy) caches will be cleaned up when their total size reaches 5 GB, but in this case, we had just one cache of 7 GB.

I noticed that Docker released [an action set](https://github.com/marketplace/actions/build-and-push-docker-images) that may suit our needs. It also supports layers caching. Additionally, we can use it later for image publication to registries. During testing the cache size was around 1 GB.

What is worth mentioning is a clever way how GH's cache action handles access to caches between branches. Long story short:
1. restore matches first caches on the current branch and later on parents - [read more](https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows#matching-a-cache-key)
2. sibling branches cannot access each other's caches - [read more](https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache)

Author: michalinacienciala

.circleci/config.yml

@@ -339,7 +339,6 @@ workflows:
             branches:
               ignore:
                 - master
-                - /rfc-18\/.*/
           context: keep-dev
       - build_token_dashboard_dapp:
           filters:

.github/workflows/client.yml

@@ -17,26 +17,51 @@ jobs:
   build-and-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: satackey/action-docker-layer-caching@v0.0.11
-        continue-on-error: true # ignore the failure of a step and avoid terminating the job
-      - name: Run Docker build
-        run: |
-          docker build \
-            --target gobuild \
-            --tag go-build-env .
-          docker build \
-            --tag keep-client .
+      - uses: actions/checkout@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-
+
+      # TODO: This step was left here intentionally so we can track disk space
+      # usage for a while. We were trying to fight problems with out of disk space
+      # that happened due to the size of data restored from cache. The cache size
+      # was growing linearly with subsequent workflow runs. We want to observe
+      # available disk space for `/`. Fresh execution starts with 20 GB, we expect
+      # to have no less than 15 GB after the cache is restored.
+      - run: sudo df -h
+
+      - name: Build Docker Build Image
+        uses: docker/build-push-action@v2
+        with:
+          target: gobuild
+          tags: go-build-env
+          build-args: |
+            REVISION=${{ github.sha }}
+          # VERSION= ? TODO: Configure version, sample: 1.7.6
+          load: true # load image to local registry to use it in next steps
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache
+
       - name: Create test results directory
         run: |
           mkdir test-results
+
       - name: Run Go tests
         run: |
           docker run \
             --volume $GITHUB_WORKSPACE/test-results:/mnt/test-results \
             --workdir /go/src/github.com/keep-network/keep-core \
             go-build-env \
             gotestsum --junitfile /mnt/test-results/unit-tests.xml
+
       - name: Publish unit test results
         uses: EnricoMi/publish-unit-test-result-action@v1.7
         if: always() # guarantees that this action always runs, even if earlier steps fail
@@ -45,3 +70,15 @@ jobs:
           files: ./test-results/unit-tests.xml
           check_name: Go Test Results # name under which test results will be presented in GitHub (optional)
           comment_on_pr: false # turns off commenting on Pull Requests
+
+      # This step is executed after the tests as we want to configure it eventually
+      # as image publication step.
+      - name: Build Docker Runtime Image
+        uses: docker/build-push-action@v2
+        with:
+          tags: keep-client
+          labels: |
+            revision=${{ github.sha }}
+          # TODO: Check branch name and publish to a registry accordingly to the
+          # environment.
+          # push: true # publish to registry

Dockerfile

@@ -1,8 +1,5 @@
 FROM golang:1.13.6-alpine3.10 AS gobuild
 
-ARG VERSION
-ARG REVISION
-
 ENV GOPATH=/go \
 	GOBIN=/go/bin \
 	APP_NAME=keep-client \
@@ -63,6 +60,10 @@ RUN go generate ./.../gen
 COPY ./ $APP_DIR/
 RUN go generate ./pkg/gen
 
+# Client Versioning.
+ARG VERSION
+ARG REVISION
+
 RUN GOOS=linux go build -ldflags "-X main.version=$VERSION -X main.revision=$REVISION" -a -o $APP_NAME ./ && \
 	mv $APP_NAME $BIN_PATH