✨ 배포 및 CI/CD 구축 (#2)

* 💬 프로젝트 정상 실행 문구 출력

* ✨ 테스트용 컨트롤러 작성

* ✨ 로컬 빌드 테스트를 위해 Dockerfile 작성

* ♻️Refactor: 코드 포맷 적용

* 🎨 코드 포맷팅 적용

* ✨ 도커 허브로 이미지 받고 로컬에서 컨테이너 띄우기

* ✨ 워크플로 생성

* 💚 배포 job 추가

---------

Co-authored-by: uni-j-uni <[email protected]>

Author: MinseoKangQ

.github/workflows/cicd.yml

@@ -0,0 +1,71 @@
+name: CI/CD to EC2 (GHCR via PAT)
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read   # 패키지 푸시는 PAT로 처리
+
+env:
+  IMAGE: ghcr.io/ai-gongmo/app
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout (with submodules)
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: "17"
+
+      - name: Build JAR
+        run: ./gradlew --no-daemon clean build -x test
+
+      # PAT로 GHCR 로그인 (GITHUB_TOKEN 아님)
+      - name: Log in to GHCR (PAT)
+        run: echo "${{ secrets.GHCR_TOKEN }}" | docker login ghcr.io -u "${{ secrets.GHCR_USERNAME }}" --password-stdin
+
+      - name: Build & Tag Docker image
+        run: |
+          docker build -f docker/Dockerfile -t $IMAGE:latest -t $IMAGE:${{ github.sha }} .
+
+      - name: Push Docker image
+        run: |
+          docker push $IMAGE:${{ github.sha }}
+          docker push $IMAGE:latest
+
+  deploy:
+    needs: build-and-push
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy over SSH
+        uses: appleboy/[email protected]
+        with:
+          host: ${{ secrets.EC2_HOST }}
+          username: ${{ secrets.EC2_USER }}
+          key: ${{ secrets.EC2_SSH_KEY }}
+          script: |
+            set -e
+            cd ~/app
+            # 최신 소스(서브모듈 포함) 갱신
+            git pull --recurse-submodules
+
+            # 이번 커밋으로 배포 태그 고정
+            sed -i "s/^IMAGE_TAG=.*/IMAGE_TAG=${{ github.sha }}/" docker/.env || true
+
+            # 컨테이너 갱신
+            cd docker
+            docker compose --env-file ./.env -f docker-compose.yml pull
+            docker compose --env-file ./.env -f docker-compose.yml up -d --remove-orphans
+
+            # 사용 안 하는 이미지 정리
+            docker image prune -af

.gitignore

@@ -40,3 +40,4 @@ src/main/resources/*.yml
 .vscode/
 
 */.env
+*.env

build.gradle

@@ -48,32 +48,32 @@ tasks.named('test') {
     useJUnitPlatform()
 }
 
-spotless {
-    java {
-        // Google JAVA Format 적용
-        googleJavaFormat()
-        // 아래 순서로 import 문 정렬
-        importOrder('java', 'javax', 'jakarta', 'org', 'com')
-        // 사용하지 않는 import 제거
-        removeUnusedImports()
-        // 각 라인 끝에 있는 공백을 제거
-        trimTrailingWhitespace()
-        // 파일 끝에 새로운 라인 추가
-        endWithNewline()
-        // 라이선스 헤더 추가
-        licenseHeader '/* \n * Copyright (c) 팀명 \n */'
-        // 어노테이션 정렬을 일관성 있게 유지
-        formatAnnotations()
-        // 들여쓰기를 공백 2칸으로 고정
-        indentWithSpaces(2)
-        // 파일 인코딩을 UTF-8로 강제
-        encoding 'UTF-8'
-    }
-}
+//spotless {
+//    java {
+//        // Google JAVA Format 적용
+//        googleJavaFormat()
+//        // 아래 순서로 import 문 정렬
+//        importOrder('java', 'javax', 'jakarta', 'org', 'com')
+//        // 사용하지 않는 import 제거
+//        removeUnusedImports()
+//        // 각 라인 끝에 있는 공백을 제거
+//        trimTrailingWhitespace()
+//        // 파일 끝에 새로운 라인 추가
+//        endWithNewline()
+//        // 라이선스 헤더 추가
+//        licenseHeader '/* Copyright (c) 팀명 */'
+//        // 어노테이션 정렬을 일관성 있게 유지
+//        formatAnnotations()
+//        // 들여쓰기를 공백 2칸으로 고정
+//        indentWithSpaces(2)
+//        // 파일 인코딩을 UTF-8로 강제
+//        encoding 'UTF-8'
+//    }
+//}
 
-tasks.named('check') {
-    dependsOn 'spotlessCheck'
-}
+//tasks.named('check') {
+//    dependsOn 'spotlessCheck'
+//}
 
 def profile = project.findProperty("profile") ?: "dev"
 
@@ -85,4 +85,4 @@ tasks.named('bootJar') {
     doFirst {
         println ">>> Building with Spring profile: $profile"
     }
-}
+}

docker/Dockerfile

@@ -0,0 +1,29 @@
+# --- Build stage ---
+FROM eclipse-temurin:17-jdk AS build
+WORKDIR /workspace
+
+# 캐시 최적화: Gradle 캐시 폴더 미리 준비
+COPY gradlew .
+COPY gradle ./gradle
+RUN chmod +x gradlew
+
+# 소스 복사
+COPY build.gradle settings.gradle ./
+COPY src ./src
+
+# 테스트 & 빌드 (테스트 생략하고 싶으면 test -x)
+RUN ./gradlew --no-daemon clean build -x test
+
+# --- Run stage ---
+FROM eclipse-temurin:17-jre
+WORKDIR /app
+
+# 빌드 산출물 복사 (jar 경로는 프로젝트에 맞게)
+COPY --from=build /workspace/build/libs/*-SNAPSHOT.jar /app/app.jar
+
+# 외부에서 바인드 마운트로 주입할 설정 폴더
+# /app/config 에 prod properties 들어올 예정
+VOLUME ["/app/config", "/app/logs"]
+
+EXPOSE 8080
+ENTRYPOINT ["java","-jar","/app/app.jar"]

docker/docker-compose.yml

@@ -0,0 +1,24 @@
+version: "3.9"
+
+services:
+  app:
+    # 로컬
+    # image: ${REGISTRY:-ghcr.io/aigongmo/app}:${IMAGE_TAG:-local}
+    image: ${REGISTRY}:${IMAGE_TAG}
+    container_name: app
+    restart: always
+    ports:
+      - "${SERVER_PORT:-8080}:8080"
+    environment:
+      SPRING_PROFILES_ACTIVE: ${SPRING_PROFILES_ACTIVE:-prod}
+      SPRING_DATASOURCE_URL: ${DB_URL}
+      SPRING_DATASOURCE_USERNAME: ${DB_USERNAME}
+      SPRING_DATASOURCE_PASSWORD: ${DB_PASSWORD}
+      # 추가 환경변수가 있으면 여기에
+      # SPRING_CONFIG_ADDITIONAL_LOCATION 로도 지정 가능
+      SPRING_CONFIG_ADDITIONAL_LOCATION: "file:/app/config/"
+    volumes:
+      # 서브모듈에 있는 prod 설정을 컨테이너에 마운트
+      - ../src/main/resources/application-prod.properties:/app/config/application-prod.properties:ro
+      # 로그 폴더
+      - ./logs:/app/logs

src/main/java/com/sku/aigongmo/AiGongmoApplication.java

@@ -8,6 +8,6 @@ public class AiGongmoApplication {
 
     public static void main(String[] args) {
         SpringApplication.run(AiGongmoApplication.class, args);
+        System.out.println("프로젝트 정상 실행 완료");
     }
-
 }

src/main/java/com/sku/aigongmo/global/common/BaseTimeEntity.java

@@ -1,22 +1,22 @@
-/* 
- * Copyright (c) SKU K-IO-SK 
- */
 package com.sku.aigongmo.global.common;
 
 import jakarta.persistence.EntityListeners;
 import jakarta.persistence.MappedSuperclass;
-import java.time.LocalDateTime;
 import lombok.Getter;
 import org.springframework.data.annotation.CreatedDate;
 import org.springframework.data.annotation.LastModifiedDate;
 import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
+import java.time.LocalDateTime;
+
 @Getter
 @MappedSuperclass
 @EntityListeners(AuditingEntityListener.class)
 public abstract class BaseTimeEntity {
 
-  @CreatedDate private LocalDateTime createdAt;
+    @CreatedDate
+    private LocalDateTime createdAt;
 
-  @LastModifiedDate private LocalDateTime modifiedAt;
+    @LastModifiedDate
+    private LocalDateTime modifiedAt;
 }

src/main/java/com/sku/aigongmo/global/config/CorsConfig.java

@@ -1,34 +1,32 @@
-/* 
- * Copyright (c) SKU K-IO-SK 
- */
 package com.sku.aigongmo.global.config;
 
-import java.util.Arrays;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.web.cors.CorsConfiguration;
 import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
 
+import java.util.Arrays;
+
 @Configuration
 public class CorsConfig {
 
-  @Value("${cors.allowed-origins}")
-  private String[] allowedOrigins;
+    @Value("${cors.allowed-origins}")
+    private String[] allowedOrigins;
 
-  @Bean
-  public UrlBasedCorsConfigurationSource corsConfigurationSource() {
-    CorsConfiguration configuration = new CorsConfiguration();
+    @Bean
+    public UrlBasedCorsConfigurationSource corsConfigurationSource() {
+        CorsConfiguration configuration = new CorsConfiguration();
 
-    // 환경 변수에 정의된 출처만 허용
-    configuration.setAllowedOrigins(Arrays.asList(allowedOrigins));
-    // 리스트에 작성한 HTTP 메소드 요청만 허용
-    configuration.setAllowedMethods(Arrays.asList("GET", "POST", "PUT", "DELETE", "PATCH"));
-    // 리스트에 작성한 헤더들이 포함된 요청만 허용
-    configuration.setAllowedHeaders(Arrays.asList("Content-Type", "X-Requested-With"));
-    // 모든 경로에 대해 위의 CORS 설정을 적용
-    UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
-    source.registerCorsConfiguration("/**", configuration);
-    return source;
-  }
+        // 환경 변수에 정의된 출처만 허용
+        configuration.setAllowedOrigins(Arrays.asList(allowedOrigins));
+        // 리스트에 작성한 HTTP 메소드 요청만 허용
+        configuration.setAllowedMethods(Arrays.asList("GET", "POST", "PUT", "DELETE", "PATCH"));
+        // 리스트에 작성한 헤더들이 포함된 요청만 허용
+        configuration.setAllowedHeaders(Arrays.asList("Content-Type", "X-Requested-With"));
+        // 모든 경로에 대해 위의 CORS 설정을 적용
+        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
+        source.registerCorsConfiguration("/**", configuration);
+        return source;
+    }
 }