chore: build CI

.github/workflows/mega-linter.yml → .github/workflows/main.yml

@@ -1,19 +1,13 @@
 ---
-# MegaLinter GitHub Action configuration file
-# More info at https://megalinter.io
-name: MegaLinter
+name: CI
 
 on:
-  # Trigger mega-linter at every push. Action will also be visible from Pull Requests to main
-  push: # Comment this line to trigger action only on pull-requests (not recommended if you don't pay for GH Actions)
+  push:
+    branches:
+      - main
   pull_request:
-    branches: [master, main]
-
-  # env: # Comment env block if you don't want to apply fixes
-  # Apply linter fixes configuration
-#  APPLY_FIXES: all # When active, APPLY_FIXES must also be defined as environment variable (in github/workflows/mega-linter.yml or other CI tool)
-#  APPLY_FIXES_EVENT: pull_request # Decide which event triggers application of fixes in a commit or a PR (pull_request, push, all)
-#  APPLY_FIXES_MODE: commit # If APPLY_FIXES is used, defines if the fixes are directly committed (commit) or posted in a PR (pull_request)
+    branches:
+      - main
 
 concurrency:
   group: ${{ github.ref }}-${{ github.workflow }}
@@ -24,8 +18,6 @@ jobs:
     name: MegaLinter
     runs-on: ubuntu-latest
     permissions:
-      # Give the default GITHUB_TOKEN write permission to commit and push, comment issues & post new PR
-      # Remove the ones you do not need
       contents: write
       issues: write
       pull-requests: write
@@ -60,3 +52,24 @@ jobs:
           path: |
             megalinter-reports
             mega-linter.log
+
+  project-build:
+    needs: megalinter
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 21
+          cache: gradle
+
+      - name: Build with Gradle
+        run: ./gradlew build --no-daemon --build-cache
+
+      - name: Build Docker image
+        run: docker build --build-arg JAR_FILE=build/libs/*.jar -t springio/gs-spring-boot-docker .

.github/workflows/pull-request.yml

@@ -0,0 +1,74 @@
+---
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  megalinter:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    steps:
+      # Git Checkout
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+          fetch-depth: 0 # If you use VALIDATE_ALL_CODEBASE = true, you can remove this line to improve performances
+
+      # MegaLinter
+      - name: MegaLinter
+        id: ml
+        # You can override MegaLinter flavor used to have faster performances
+        # More info at https://megalinter.io/latest/flavors/
+        uses: oxsecurity/megalinter@latest
+        env:
+          # All available variables are described in documentation
+          # https://megalinter.io/latest/configuration/
+          VALIDATE_ALL_CODEBASE: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} # Validates all source when push on main, else just the git diff with main. Override with true if you always want to lint all sources
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # ADD YOUR CUSTOM ENV VARIABLES HERE OR DEFINE THEM IN A FILE .mega-linter.yml AT THE ROOT OF YOUR REPOSITORY
+          # DISABLE: COPYPASTE,SPELL # Uncomment to disable copy-paste and spell checks
+
+      # Upload MegaLinter artifacts
+      - name: Archive production artifacts
+        if: success() || failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: MegaLinter reports
+          path: |
+            megalinter-reports
+            mega-linter.log
+
+  project-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: 21
+          cache: gradle
+
+      - name: Build with Gradle
+        run: ./gradlew build --no-daemon --build-cache
+
+      - name: Build Docker image
+        run: docker build --build-arg JAR_FILE=build/libs/*.jar -t springio/gs-spring-boot-docker .

Dockerfile

@@ -0,0 +1,19 @@
+FROM openjdk:21-slim
+
+# Create a group and user
+RUN groupadd -r spring && useradd -r -g spring spring
+
+WORKDIR /app
+COPY build/libs/*.jar /app/app.jar
+
+# Set Spring Boot Actuator endpoint settings in environment variables
+ENV SPRINGPROFILES=prod
+
+# Use the user created above
+USER spring:spring
+EXPOSE 8080
+
+# Health check for the application
+HEALTHCHECK --interval=30s --timeout=10s --retries=3 CMD curl -f http://localhost:8080/actuator/health || exit 1
+
+ENTRYPOINT ["java", "-jar", "/app/app.jar"]

build.gradle

@@ -27,6 +27,7 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
 	implementation 'org.springframework.boot:spring-boot-starter-validation'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
+	implementation 'org.springframework.boot:spring-boot-starter-actuator:3.3.4'
 	compileOnly 'org.projectlombok:lombok'
 	runtimeOnly 'com.h2database:h2'
 	runtimeOnly 'org.postgresql:postgresql'

src/main/java/tw/commonground/backend/BackendApplication.java

@@ -2,12 +2,29 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
 
 @SpringBootApplication
+@RestController
 public class BackendApplication {
+  /**
+   * Handles requests to the root URL ("/") and returns a greeting message.
+   *
+   * @return A string greeting message.
+   */
+  @RequestMapping("/")
+  public String home() {
+    return "Hello Docker World";
+  }
 
-	public static void main(String[] args) {
-		SpringApplication.run(BackendApplication.class, args);
-	}
+  /**
+   * The entry point of the application.
+   *
+   * @param args command-line arguments (if any)
+   */
+  public static void main(final String[] args) {
+    SpringApplication.run(BackendApplication.class, args);
+  }
 
 }

src/main/java/tw/commonground/backend/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * This package contains classes and interfaces for the backend application of Common Ground.
+ */
+package tw.commonground.backend;

src/main/resources/application.properties

@@ -1 +1,7 @@
+# Application name
 spring.application.name=backend
+
+# Enable and configure Actuator endpoints
+management.endpoints.web.exposure.include=health,info
+management.endpoint.health.show-details=always
+management.endpoints.web.base-path=/actuator