Merge pull request #37 from CoverGo/f/BE-651-add-github-token-to-docker

feat: add GITHUB_TOKEN as an argument to build

Author: Spaier

.gflows/libs/steps.lib.yml

@@ -18,7 +18,7 @@ with:
 #@ def _checkout():
 name: Checkout repository
 uses: actions/checkout@v3
-#@ end 
+#@ end
 ---
 #@ def _generate_docker_meta():
 #@ custom_labels = []
@@ -29,12 +29,12 @@ uses: docker/metadata-action@v3
 with:
   images: name/app
   labels: #@ "\n".join(custom_labels)
-#@ end 
+#@ end
 ---
 #@ def _setup_qemu():
 name: Set up QEMU
 uses: docker/setup-qemu-action@v1
-#@ end 
+#@ end
 ---
 #@ def _setup_buildx():
 name: Set up Docker Buildx
@@ -62,7 +62,7 @@ with:
 #@ def _build_and_push_docker(component, cache_registry, step_name=None, step_id=None, push_image=True, load_image=False, tags=None, build_versioned_image = False):
 name: #@ common.get_value(step_name, job.name.docker_build(component.name))
 uses: docker/build-push-action@v3
-#@ if step_id != None : 
+#@ if step_id != None :
 id: #@ step_id
 #@ end
 #@ if tags == None :
@@ -80,10 +80,10 @@ id: #@ step_id
 #@ for cache_image in cache_images:
 #@  cache_refs.append("type=registry,ref={}".format(cache_image))
 #@ end
-#@ 
+#@
 #@ cache_from_multiline_string = "\n".join(cache_refs)
 #@ cache_registry = struct.make(cache_from =cache_from_multiline_string, cache_to = "type=registry,ref={},mode={}".format(own_cache_image,getattr(component,"cache_mode","max")))
-  
+
 #@ cache_params = {"gha":cache_gha, "registry":cache_registry}
 
 #@ cache_type = cfg.get_cache_type(component)
@@ -104,7 +104,7 @@ with:
   #@ end
   #@ if cfg.should_push_cache(component):
   cache-to: #@ cache_params[cache_type].cache_to
-  #@ end 
+  #@ end
   #@ if hasattr(component,"docker_target"):
   target: #@ component.docker_target
   #@ end
@@ -113,6 +113,7 @@ with:
   #@  build_args += component.build_args
   #@ end
   #@ build_args.append("COMMIT_SHA=${{ github.sha }}")
+  #@ build_args.append("GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}")
   #@ if build_versioned_image:
   #@ build_args.append("BUILD_DATETIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}")
   #@ build_args.append("APP_VERSION=${{ needs.version.outputs.app_version }}")
@@ -152,4 +153,4 @@ run: #@ "echo ${{ steps." + step_id + ".outputs.digest }}"
 #@ generate_docker_meta = _generate_docker_meta,
 #@ define_docker_outputs = _define_docker_outputs,
 #@ echo_docker_digest = _echo_docker_digest)
----
+---

github-sample/workflows/build-publish.yml

@@ -112,6 +112,7 @@ jobs:
           type=registry,ref=ghcr.io/covergo/auth-nuget-cache:${{ needs.version.outputs.issue_id_slug }}
         build-args: |-
           COMMIT_SHA=${{ github.sha }}
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
           BUILD_DATETIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
           APP_VERSION=${{ needs.version.outputs.app_version }}
           FILE_VERSION=${{ needs.version.outputs.file_version }}
@@ -184,6 +185,7 @@ jobs:
         cache-to: type=registry,ref=ghcr.io/covergo/auth-nuget-default-cache:${{ needs.version.outputs.issue_id_slug }},mode=max
         build-args: |-
           COMMIT_SHA=${{ github.sha }}
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
           BUILD_DATETIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
           APP_VERSION=${{ needs.version.outputs.app_version }}
           FILE_VERSION=${{ needs.version.outputs.file_version }}
@@ -269,6 +271,7 @@ jobs:
         build-args: |-
           NOW="$(date -u +'%Y-%m-%dT%H:%M:%SZ')"
           COMMIT_SHA=${{ github.sha }}
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
           BUILD_DATETIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
           APP_VERSION=${{ needs.version.outputs.app_version }}
           FILE_VERSION=${{ needs.version.outputs.file_version }}
@@ -318,6 +321,7 @@ jobs:
         target: build-predeployment
         build-args: |-
           COMMIT_SHA=${{ github.sha }}
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
           BUILD_DATETIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
           APP_VERSION=${{ needs.version.outputs.app_version }}
           FILE_VERSION=${{ needs.version.outputs.file_version }}
@@ -359,7 +363,9 @@ jobs:
           type=registry,ref=ghcr.io/covergo/auth-cache:${{ needs.version.outputs.issue_id_slug }}
           type=registry,ref=ghcr.io/covergo/auth-test-unit-cache:${{ needs.version.outputs.issue_id_slug }}
         cache-to: type=registry,ref=ghcr.io/covergo/auth-test-unit-cache:${{ needs.version.outputs.issue_id_slug }},mode=min
-        build-args: COMMIT_SHA=${{ github.sha }}
+        build-args: |-
+          COMMIT_SHA=${{ github.sha }}
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
     - name: Image digest
       run: echo ${{ steps.docker-build-auth-test-unit.outputs.digest }}
   run-auth-test-unit:
@@ -448,7 +454,9 @@ jobs:
           type=registry,ref=ghcr.io/covergo/auth-test-unit-cache:${{ needs.version.outputs.issue_id_slug }}
           type=registry,ref=ghcr.io/covergo/cases-mariadb-test-integration-cache:${{ needs.version.outputs.issue_id_slug }}
         cache-to: type=registry,ref=ghcr.io/covergo/cases-mariadb-test-integration-cache:${{ needs.version.outputs.issue_id_slug }},mode=max
-        build-args: COMMIT_SHA=${{ github.sha }}
+        build-args: |-
+          COMMIT_SHA=${{ github.sha }}
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
     - name: Image digest
       run: echo ${{ steps.docker-build-integration-tests.outputs.digest }}
     - name: Checkout repository
@@ -553,7 +561,9 @@ jobs:
           type=registry,ref=ghcr.io/covergo/cases-api-test-integration-cache:${{ needs.version.outputs.issue_id_slug }}
           type=registry,ref=ghcr.io/covergo/cases-test-acceptance-cache:${{ needs.version.outputs.issue_id_slug }}
         cache-to: type=registry,ref=ghcr.io/covergo/cases-test-acceptance-cache:${{ needs.version.outputs.issue_id_slug }},mode=max
-        build-args: COMMIT_SHA=${{ github.sha }}
+        build-args: |-
+          COMMIT_SHA=${{ github.sha }}
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
     - name: Image digest
       run: echo ${{ steps.docker-build-acceptance-tests.outputs.digest }}
   run-acceptance-tests:
@@ -687,7 +697,9 @@ jobs:
           type=registry,ref=ghcr.io/covergo/auth-test-unit-cache:${{ needs.version.outputs.issue_id_slug }}
           type=registry,ref=ghcr.io/covergo/cases-api-test-integration-cache:${{ needs.version.outputs.issue_id_slug }}
         cache-to: type=registry,ref=ghcr.io/covergo/cases-api-test-integration-cache:${{ needs.version.outputs.issue_id_slug }},mode=max
-        build-args: COMMIT_SHA=${{ github.sha }}
+        build-args: |-
+          COMMIT_SHA=${{ github.sha }}
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
     - name: Image digest
       run: echo ${{ steps.docker-build-api-test-integration.outputs.digest }}
   run-api-test-integration:
@@ -1124,7 +1136,9 @@ jobs:
         tags: ghcr.io/covergo/auth-mongo:${{ needs.version.outputs.app_version }}
         cache-from: type=registry,ref=ghcr.io/covergo/auth-mongo-cache:${{ needs.version.outputs.issue_id_slug }}
         cache-to: type=registry,ref=ghcr.io/covergo/auth-mongo-cache:${{ needs.version.outputs.issue_id_slug }},mode=max
-        build-args: COMMIT_SHA=${{ github.sha }}
+        build-args: |-
+          COMMIT_SHA=${{ github.sha }}
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}
     - name: Image digest
       run: echo ${{ steps.docker-build-auth-mongo.outputs.digest }}
   deploy-tenant-tahoe: