fix: app version represents the git tag (#185)

* fix: app version represents the git tag * refactor: APP_VERSION is now given at the build time * chore: run pretty
42atomys · Jul 20, 2022 · 6b87ad9 · 6b87ad9
1 parent 91e6db1
commit 6b87ad9
Show file tree

Hide file tree

Showing 18 changed files with 642 additions and 725 deletions.
diff --git a/.github/workflows/deployer.yaml b/.github/workflows/deployer.yaml
@@ -1,19 +1,19 @@
-name: 'Deployer 🔧'
+name: "Deployer 🔧"
 on:
   # Disabled due to the private repository and no review-apps currently supported
-  # pull_request: 
+  # pull_request:
   #   branches:
   #   - main
   push:
     branches:
-    - main
+      - main
   release:
     types:
-    - prereleased
-    - released
+      - prereleased
+      - released
 jobs:
   build_and_push:
-    name: 'Build & push to ghcr.io 🔧'
+    name: "Build & push to ghcr.io 🔧"
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -22,73 +22,75 @@ jobs:
       REGISTRY: ghcr.io
       IMAGE_NAME: ${{ github.repository }}
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    - name: Log in to the Container registry
-      uses: docker/login-action@v2
-      with:
-        registry: ${{ env.REGISTRY }}
-        username: ${{ github.actor }}
-        password: ${{ secrets.GITHUB_TOKEN }}
-
-    - name: Extract metadata (tags, labels) for Docker
-      id: meta
-      uses: docker/metadata-action@v4
-      with:
-        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
-        github-token: ${{ github.token }}
-
-    - name: Build and push Docker image
-      uses: docker/build-push-action@v3
-      with:
-        context: .
-        push: true
-        tags: ${{ steps.meta.outputs.tags }}
-        labels: ${{ steps.meta.outputs.labels }}
-        file: build/Dockerfile
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          github-token: ${{ github.token }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          file: build/Dockerfile
+          build-args: |
+            APP_VERSION=${{ steps.meta.outputs.version }}
 
   deploy_sandbox:
     name: Deploy to sandbox 🏖
     runs-on: ubuntu-latest
-    needs: [ build_and_push ]
+    needs: [build_and_push]
     if: ${{ contains('refs/heads/main', github.ref) }}
     steps:
-    - uses: actions/checkout@v3
-    - uses: azure/setup-kubectl@v3.0
-    - uses: imranismail/setup-kustomize@v1
-    - uses: azure/k8s-set-context@v3
-      with:
-        method: kubeconfig
-        kubeconfig: ${{ secrets.KUBECONFIG_ADMIN }}
-        cluster-type: generic
-    - run: |
-        kustomize build deploy/app/config/overlays/sandbox | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/jwtks-service/overlays/sandbox
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/api/overlays/sandbox
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/interface/overlays/sandbox
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/crawler-campus/overlays/sandbox
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/crawler-locations/overlays/sandbox
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
-        kustomize build . | kubectl apply -f -
+      - uses: actions/checkout@v3
+      - uses: azure/setup-kubectl@v3.0
+      - uses: imranismail/setup-kustomize@v1
+      - uses: azure/k8s-set-context@v3
+        with:
+          method: kubeconfig
+          kubeconfig: ${{ secrets.KUBECONFIG_ADMIN }}
+          cluster-type: generic
+      - run: |
+          kustomize build deploy/app/config/overlays/sandbox | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/jwtks-service/overlays/sandbox
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/api/overlays/sandbox
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/interface/overlays/sandbox
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/crawler-campus/overlays/sandbox
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/crawler-locations/overlays/sandbox
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.ref_name }}
+          kustomize build . | kubectl apply -f -
 
   deploy_next:
     name: Deploy to next 🎉
     runs-on: ubuntu-latest
-    needs: [ build_and_push ]
+    needs: [build_and_push]
     if: |
       github.event.action == 'prereleased' ||
       (
@@ -97,41 +99,41 @@ jobs:
         github.event.release.prerelease == true
       )
     steps:
-    - uses: actions/checkout@v3
-    - uses: azure/setup-kubectl@v3.0
-    - uses: imranismail/setup-kustomize@v1
-    - uses: azure/k8s-set-context@v3
-      with:
-        method: kubeconfig
-        kubeconfig: ${{ secrets.KUBECONFIG_ADMIN }}
-        cluster-type: generic
-    - run: |
-        kustomize build deploy/app/config/overlays/next | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/jwtks-service/overlays/next
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/api/overlays/next
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/interface/overlays/next
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/crawler-campus/overlays/next
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/crawler-locations/overlays/next
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
+      - uses: actions/checkout@v3
+      - uses: azure/setup-kubectl@v3.0
+      - uses: imranismail/setup-kustomize@v1
+      - uses: azure/k8s-set-context@v3
+        with:
+          method: kubeconfig
+          kubeconfig: ${{ secrets.KUBECONFIG_ADMIN }}
+          cluster-type: generic
+      - run: |
+          kustomize build deploy/app/config/overlays/next | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/jwtks-service/overlays/next
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/api/overlays/next
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/interface/overlays/next
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/crawler-campus/overlays/next
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/crawler-locations/overlays/next
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
 
   deploy_live:
     name: Deploy to live 🚀
     runs-on: ubuntu-latest
-    needs: [ build_and_push, deploy_next ]
+    needs: [build_and_push, deploy_next]
     if: |
       always() &&
       (needs.build_and_push.result == 'success') &&
@@ -143,36 +145,36 @@ jobs:
         github.event.release.prerelease == false
       )
     steps:
-    - uses: actions/checkout@v3
-    - uses: azure/setup-kubectl@v3.0
-    - uses: azure/k8s-set-context@v3
-      with:
-        method: kubeconfig
-        kubeconfig: ${{ secrets.KUBECONFIG_ADMIN }}
-        cluster-type: generic
-    - run: |
-        kustomize build deploy/app/config/overlays/live | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/jwtks-service/overlays/live
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/api/overlays/live
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/interface/overlays/live
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/crawler-campus/overlays/live
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
-
-        # cd ${{github.workspace }}/deploy/app/crawler-locations/overlays/live
-        # kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        # kustomize build . | kubectl apply -f -
-
-        cd ${{github.workspace }}/deploy/app/webhooks-processor/overlays/live
-        kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
-        kustomize build . | kubectl apply -f -
+      - uses: actions/checkout@v3
+      - uses: azure/setup-kubectl@v3.0
+      - uses: azure/k8s-set-context@v3
+        with:
+          method: kubeconfig
+          kubeconfig: ${{ secrets.KUBECONFIG_ADMIN }}
+          cluster-type: generic
+      - run: |
+          kustomize build deploy/app/config/overlays/live | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/jwtks-service/overlays/live
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/api/overlays/live
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/interface/overlays/live
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/crawler-campus/overlays/live
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
+
+          # cd ${{github.workspace }}/deploy/app/crawler-locations/overlays/live
+          # kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          # kustomize build . | kubectl apply -f -
+
+          cd ${{github.workspace }}/deploy/app/webhooks-processor/overlays/live
+          kustomize edit set image app=ghcr.io/42atomys/stud42:${{ github.event.release.tag_name }}
+          kustomize build . | kubectl apply -f -
diff --git a/build/Dockerfile b/build/Dockerfile
@@ -1,12 +1,14 @@
+ARG APP_VERSION
 # GOLANG BUILD - BUILD
 FROM golang:1.18 AS go-build
 
 WORKDIR /build
 COPY . /build
+ENV APP_VERSION=${APP_VERSION}
 
 RUN apt-get update && \
-    apt-get install -y unzip jq && \
-    make -f build/Makefile deps generate build
+  apt-get install -y unzip jq && \
+  make -f build/Makefile deps generate build
 
 # INTERFACE BUILD - DEPS
 FROM node:16 AS node-deps
@@ -20,14 +22,15 @@ WORKDIR /build
 COPY --from=node-deps /build/node_modules ./node_modules
 COPY . .
 
-ENV NEXT_TELEMETRY_DISABLED 1
+ENV NEXT_TELEMETRY_DISABLED 1 \
+  APP_VERSION=${APP_VERSION}
 
 RUN apt-get update -y && \
-    apt-get install -y jq && \
-    make -f build/Makefile deps && \
-    cd web/ui && \
-    yarn add -D @graphql-codegen/cli && \
-    yarn generate && yarn build
+  apt-get install -y jq && \
+  make -f build/Makefile deps && \
+  cd web/ui && \
+  yarn add -D @graphql-codegen/cli && \
+  yarn generate && yarn build
 
 
 # RUNNER 
@@ -38,7 +41,8 @@ LABEL repository "https://github.com/42Atomys/stud42"
 
 WORKDIR /app
 
-ENV NEXT_TELEMETRY_DISABLED 1
+ENV NEXT_TELEMETRY_DISABLED 1 \
+  APP_VERSION=${APP_VERSION}
 
 COPY --from=node-builder /build/web/ui/next.config.js ./
 COPY --from=node-builder /build/web/ui/public ./public