MP2381-Versioning-Dashboard

.dockerignore

@@ -1,8 +1,17 @@
 *
+
+# Backend
 !internal
 !cmd
 !pkg
 !main.go
 !go.mod
 !go.sum
-!LICENSE
+
+# Dashboard
+!dashboard/*
+dashboard/node_modules
+
+# Other
+!LICENSE
+!docker/*

.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false
+
+[COMMIT_EDITMSG]
+max_line_length = 0

.env.example

@@ -4,3 +4,6 @@ SERVER_PORT=9000
 
 LOG_LEVEL: debug
 LOG_FORMAT: text
+
+AWS_REGION=eu-west-1
+AWS_BUCKET_NAME=my-bucket

.github/workflows/ci.yml

@@ -1,39 +1,122 @@
 name: CI
 
-permissions:
-  contents: read
-  pull-requests: read
-
 on:
+  workflow_dispatch: {}
+  pull_request: {}
+  release:
+    types: [published]
   push:
-    branches: [master]
-  pull_request:
-    branches: [master]
+    branches:
+      - master
+      - develop
+      - release/*
+      - feature/*
+      - hotfix/*
 
 jobs:
   test:
-    runs-on: self-hosted
+    runs-on: default
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.23
+
+      - name: Cache Go Modules
+        uses: actions/cache@v3
         with:
-          go-version: 1.19
+          path: |
+            ~/.cache/go-build
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ matrix.go-version }}-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-${{ matrix.go-version }}-
 
       - name: Test
         run: go test -v ./...
 
   lint:
     name: lint
-    runs-on: self-hosted
+    runs-on: default
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.23
 
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v6
         with:
           version: latest
           github-token: ${{secrets.GITHUB_TOKEN}}
           only-new-issues: true
+
+  build:
+    name: Build 🏗
+    runs-on: default
+    needs: [lint, test]
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}-build
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Generate Docker Metadata
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ inputs.image_name }}
+          tags: |
+            # Raw sha of the commit
+            type=raw,value={{sha}}
+
+            # Branch name with and without the sha suffix
+            type=raw,value={{branch}},enable=${{ github.event_name == 'push' }}
+            type=raw,value={{branch}}-{{sha}},enable=${{ github.event_name == 'push' }}
+
+            # Branch name with and without the sha suffix and unix timestamp milliseconds
+            type=raw,value={{branch}}-{{date 'x'}},enable=${{ github.event_name == 'push' }}
+            type=raw,value={{branch}}-{{sha}}-{{date 'x'}},enable=${{ github.event_name == 'push' }}
+
+            # PR number with and without the sha suffix
+            type=raw,value=${{github.head_ref}},enable=${{ github.event_name == 'pull_request' }}
+            type=raw,value=${{github.head_ref}}-{{sha}},enable=${{ github.event_name == 'pull_request' }}
+
+            # Release tag
+            type=semver,pattern={{version}},enable=${{ github.event_name == 'release' }}
+            type=raw,value={{tag}},enable=${{ github.event_name == 'release' }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Registry
+        uses: docker/login-action@v3
+        with:
+          registry: docker.wiseflow.io
+          username: ${{ secrets.HARBOR_USERNAME }}
+          password: ${{ secrets.HARBOR_TOKEN }}
+
+      - name: Build and Push
+        uses: docker/build-push-action@v5
+        with:
+          provenance: false
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha,scope=build
+          cache-to: type=gha,mode=max,scope=build
+          platforms: ${{ inputs.platforms }}
+
+      - name: Write summary
+        run: |
+          echo "# Image tags" >> $GITHUB_STEP_SUMMARY
+          for tag in ${{ join(fromJSON(steps.meta.outputs.json).tags, ' ') }}
+          do
+            echo "- $tag" >> $GITHUB_STEP_SUMMARY
+          done

.gitignore

@@ -16,3 +16,4 @@
 
 .env
 .parrot.yaml
+.vite/

.golangci.yml

@@ -1,13 +1,8 @@
 linters:
-  enable-all: true
-  disable:
-    - wsl
-    - gochecknoglobals
-    - exhaustivestruct
-    - wrapcheck
-
-    # Deprecated
-    - scopelint
-    - golint
-    - maligned
-    - interfacer
+  disable: []
+run:
+  tests: false
+issues:
+  exclude-files:
+    - ".*\\.pb\\.go$"
+    - ".*\\_mock\\.go$"

Dockerfile

@@ -1,32 +1,43 @@
 ############################
-# STEP 1 build base
+# Backend build
 ############################
-FROM golang:1.19-alpine3.17 as build-base
-RUN apk add --update --no-cache git ca-certificates build-base
+FROM golang:1.23-alpine3.20 AS backend-builder
 WORKDIR /build
-ENV GO111MODULE=on
+
 COPY go.mod .
 COPY go.sum .
 RUN go mod download -x
 
+COPY . .
+RUN GOOS=linux GOARCH=amd64 go build -o /build/bin/parrot main.go
+
 ############################
-# STEP 2 image base
+# Frontend build
 ############################
-FROM alpine:3.17 as image-base
+FROM node:20-alpine3.20 AS frotnend-builder
 WORKDIR /app
-COPY --from=build-base /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
-ENTRYPOINT ["/app/parrot", "serve"]
 
-############################
-# STEP 3 build executable
-############################
-FROM build-base AS builder
-COPY . .
-RUN CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -o /build/bin/parrot main.go
+RUN npm install -g pnpm
+
+COPY ./dashboard/package.json .
+COPY ./dashboard/pnpm-lock.yaml .
+RUN pnpm install --frozen-lockfile
+
+COPY ./dashboard /app
+RUN pnpm build
+
 
 ############################
-# STEP 4 Finalize image
+# Finalize image
 ############################
-FROM image-base
+FROM nginx:1.27.2-alpine3.20 AS image-base
+WORKDIR /
+ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]
+
 COPY LICENSE .
-COPY --from=builder /build/bin/parrot parrot
+
+COPY ./docker/nginx.conf /etc/nginx
+COPY ./docker/entrypoint.sh /
+
+COPY --from=backend-builder /build/bin/parrot /usr/local/bin/parrot
+COPY --from=frotnend-builder /app/dist /usr/share/nginx/html

README.md

@@ -33,7 +33,8 @@ The server can be configured with a yaml configuration file specified with the `
 
 | key                            | description                                                                  | type     | default                      |
 | ------------------------------ | ---------------------------------------------------------------------------- | -------- | ---------------------------- |
-| server.port                    | port for the main http server                                                | int      | `80`                         |
+| server.port.public                    | port for the public http server                                                | int      | `80`                         |
+| server.port.private                    | port for the private http server                                                | int      | `81`                         |
 | server.gracePeriod             | grace period for the http server to shutdown                                 | duration | `10s`                        |
 | log.level                      | log level                                                                    | string   | `info`                       |
 | log.format                     | format of the log. Can be "text" or "json"                                   | string   | `json`                       |
@@ -54,6 +55,9 @@ The server can be configured with a yaml configuration file specified with the `
 | prometheus.path                | expose prometheus metrics under path                                         | string   | `/metrics`                   |
 | prometheus.port                | port to expose the prometheus metrics under                                  | int      | `9090`                       |
 | api.token                      | secret token to authenticating against poeditor                              | string   |
+| aws.region                    | AWS Region | string | `eu-west-1` |
+| aws.bucket                    | AWS bucket | string | 
+
 
 # API specification