Adding GHA pipelines

Author: gavlyukovskiy

.github/workflows/build.yml

@@ -0,0 +1,45 @@
+name: Build
+on:
+  push:
+    branches:
+      - main
+    tags-ignore:
+      - '*'
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+concurrency:
+  # On main, we don't want any jobs cancelled so the sha is used to name the group
+  # On PR branches, we cancel the job if new commits are pushed
+  # More info: https://stackoverflow.com/a/68422069/253468
+  group: ${{ (github.ref == 'refs/heads/main') && format('{0}-{1}', github.workflow_ref, github.sha) || format('{0}-{1}', github.workflow_ref, github.head_ref) }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    permissions:
+      contents: read
+      checks: write # for publishing test results and annotations
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+          cache: 'gradle'
+
+      - name: Build
+        run: ./gradlew build
+
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@v5
+        if: ${{ !cancelled() }} # always run even if the previous step fails
+        with:
+          report_paths: '**/build/test-results/test/TEST-*.xml'

.github/workflows/on-release-tag.yaml

@@ -0,0 +1,48 @@
+name: Tag & Release Workflow
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to release (must start with "v")'
+        required: true
+
+jobs:
+  build-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+    outputs:
+      digest: ${{ steps.push.outputs.digest }}
+      tags: ${{ steps.meta.outputs.tags }}
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+          cache: 'gradle'
+
+      - uses: docker/setup-buildx-action@v3
+        with:
+          platforms: linux/amd64
+
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build
+        env:
+          DOCKER_PUSH: true
+        run: ./gradlew \
+          -Pversion=${GITHUB_REF_NAME#v:-"${{ github.event.inputs.version }}"} \
+          bootBuildImage

README.md

@@ -65,3 +65,9 @@ After the image is built, you can run it using a special Docker Compose profile
 ```bash
 docker compose --profile include-course-hub up
 ```
+
+### Cleanup
+
+Keep in mind that containers will keep running in the background even after you stop the application. To stop and remove the containers, run:
+```bash
+docker compose --profile include-course-hub down -v

build.gradle

@@ -44,3 +44,9 @@ test {
     }
     jvmArgs.add("-javaagent:${configurations.mockitoAgent.asPath}")
 }
+
+tasks.named("bootBuildImage") {
+    imageName.set("ghcr.io/hackyourfuture/course-hub-backend")
+    tags.set(["ghcr.io/hackyourfuture/course-hub-backend:" + version])
+    publish.set(System.getenv("DOCKER_PUSH")?.toBoolean() ?: false)
+}

docker-compose.yaml

@@ -10,20 +10,8 @@ services:
       POSTGRES_DB: coursehub
     ports:
       - "5432:5432"
-  course-hub-ui:
-    image: node:alpine
-    container_name: course-hub-ui
-    entrypoint: /bin/sh
-    ports:
-      - 8000:8000
-    working_dir: /srv/app
-    volumes:
-      - type: bind
-        source: ./ui
-        target: /srv/app
-    tty: true
   course-hub:
-    image: course-hub:0.0.1-SNAPSHOT
+    image: ghcr.io/hackyourfuture/course-hub-backend:latest
     container_name: course-hub
     profiles:
       - include-course-hub

src/main/java/net/hackyourfuture/coursehub/web/CourseController.java

@@ -1,13 +1,10 @@
 package net.hackyourfuture.coursehub.web;
 
 import net.hackyourfuture.coursehub.service.CourseService;
-import net.hackyourfuture.coursehub.web.model.CourseDto;
 import net.hackyourfuture.coursehub.web.model.CourseListResponse;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RestController;
 
-import java.util.List;
-
 @RestController
 public class CourseController {