release-1.0

.github/pull_request_template.md

@@ -0,0 +1,24 @@
+### 요약
+
+### 변경한 부분
+
+### 질문
+
+### 변경한 결과
+
+
+
+---
+
+## PR 유형
+
+어떤 변경 사항이 있나요?
+
+- [ ] 새로운 기능 추가
+- [ ] 버그 수정
+- [ ] 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경, 주석 변경)
+- [ ] 코드 리팩토링
+- [ ] 문서 수정
+- [ ] 테스트 추가, 테스트 리팩토링
+- [ ] 파일 혹은 폴더명 수정, 삭제
+- [ ] 배포 관련

.github/workflows/cd.yml

@@ -0,0 +1,84 @@
+name: Withaeng CD with Gradle, Github Actions
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    environment: prod
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: temurin
+
+      - name: Cache Gradle dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+        shell: bash
+
+      - name: Build with Gradle
+        run: ./gradlew clean build
+        shell: bash
+
+      - name: Clean Server Directory
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.SERVER_HOST }}
+          username: ${{ secrets.SERVER_USERNAME }}
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: sudo rm -rf /tmp/withaeng-api
+
+      - name: Send build artifacts to server
+        uses: appleboy/scp-action@master
+        with:
+          host: ${{ secrets.SERVER_HOST }}
+          username: ${{ secrets.SERVER_USERNAME }}
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          source: withaeng-api
+          target: /tmp
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: prod
+
+    steps:
+      - name: Run Docker Compose
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.SERVER_HOST }}
+          username: ${{ secrets.SERVER_USERNAME }}
+          key: ${{ secrets.SERVER_SSH_KEY }}
+          script: |
+            export SPRING_PROFILES_ACTIVE=prod
+            export DATABASE_DRIVER=${{ secrets.DATABASE_DRIVER }}
+            export DATABASE_URL=${{ secrets.DATABASE_URL }}
+            export DATABASE_USERNAME=${{ secrets.DATABASE_USERNAME }}
+            export DATABASE_PASSWORD=${{ secrets.DATABASE_PASSWORD }}
+            export WITHAENG_HOST=${{ secrets.WITHAENG_HOST }}
+            export JWT_ISSUER=${{ secrets.JWT_ISSUER }}
+            export JWT_SECRET_KEY=${{ secrets.JWT_SECRET_KEY }}
+            export AWS_ACCESS_KEY=${{ secrets.AWS_ACCESS_KEY }}
+            export AWS_SECRET_KEY=${{ secrets.AWS_SECRET_KEY }}
+            export AWS_SES_REGION=${{ secrets.AWS_SES_REGION }}
+            export AWS_SES_FROM=${{ secrets.AWS_SES_FROM }}
+            sudo -E docker compose -f /tmp/withaeng-api/docker-compose.yml down
+            sudo -E docker compose -f /tmp/withaeng-api/docker-compose.yml up --build -d

.github/workflows/pr.yml

@@ -0,0 +1,29 @@
+name: Pull request workflow (build check)
+
+on:
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: 17
+          distribution: temurin
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew build -x test
+
+      - name: Test with Gradle
+        run: SPRING_PROFILES_ACTIVE=[test] ./gradlew test

.gitignore

@@ -1,3 +1,6 @@
+*-local.properties
+*-local.yaml
+*-local.yml
 HELP.md
 .gradle
 build/

build.gradle.kts

@@ -1,45 +1,47 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-    id("org.springframework.boot") version "3.2.2"
-    id("io.spring.dependency-management") version "1.1.4"
-    kotlin("jvm") version "1.9.22"
-    kotlin("plugin.spring") version "1.9.22"
-    kotlin("plugin.jpa") version "1.9.22"
+    kotlin("jvm")
+    kotlin("kapt") version "1.9.10"
+    kotlin("plugin.spring") apply false
+    kotlin("plugin.jpa") apply false
+    id("org.springframework.boot") apply false
+    id("io.spring.dependency-management") apply false
 }
 
 java {
     sourceCompatibility = JavaVersion.VERSION_17
 }
 
+val projectGroup: String by project
+val applicationVersion: String by project
 allprojects {
-    group = "com.travel"
-    version = "0.0.1-SNAPSHOT"
+    group = projectGroup
+    version = applicationVersion
 
     repositories {
         mavenCentral()
     }
 }
 
+val springMockkVersion: String by project.extra
+
 subprojects {
     apply(plugin = "org.jetbrains.kotlin.jvm")
+    apply(plugin = "org.jetbrains.kotlin.kapt")
     apply(plugin = "org.jetbrains.kotlin.plugin.spring")
+    apply(plugin = "org.jetbrains.kotlin.plugin.jpa")
     apply(plugin = "org.springframework.boot")
-    apply(plugin = "kotlin")
-    apply(plugin = "java-library")
-    apply(plugin = "kotlin-jpa")
     apply(plugin = "io.spring.dependency-management")
-    apply(plugin = "kotlin-kapt")
-    apply(plugin = "application")
 
     dependencies {
+        implementation("org.springframework.boot:spring-boot-starter-web")
         implementation("org.jetbrains.kotlin:kotlin-reflect")
-        developmentOnly("org.springframework.boot:spring-boot-devtools")
         implementation("com.fasterxml.jackson.module:jackson-module-kotlin")
 
         // SpringMockk
         testImplementation("org.springframework.boot:spring-boot-starter-test")
-        testImplementation("com.ninja-squad:springmockk:3.1.1")
+        testImplementation("com.ninja-squad:springmockk:$springMockkVersion")
 
         runtimeOnly("com.h2database:h2")
     }
@@ -55,11 +57,11 @@ subprojects {
         useJUnitPlatform()
     }
 
-    tasks.bootJar {
+    tasks.getByName("bootJar") {
         enabled = false
     }
 
-    tasks.jar {
+    tasks.getByName("jar") {
         enabled = true
     }
 }

gradle.properties

@@ -0,0 +1,18 @@
+### Application version ###
+applicationVersion=0.0.1
+### Project configs ###
+projectGroup=com.withaeng
+### Project dependency versions ###
+kotlinVersion=1.9.22
+### Spring dependency versions ###
+springBootVersion=3.2.2
+springDependencyManagementVersion=1.1.4
+### Spring mockk ####
+springMockkVersion=3.1.1
+### Persistence versions ###
+mysqlVersion=8.3.0
+queryDslVersion=5.1.0:jakarta
+### jjwt version
+jjwtVersion=0.11.5
+### Swagger Version
+swaggerVersion=2.2.0

settings.gradle.kts

@@ -1,6 +1,25 @@
-plugins {
-    id("org.gradle.toolchains.foojay-resolver-convention") version "0.5.0"
-}
 rootProject.name = "withaeng"
-include("withaeng-api")
-include("withaeng-domain")
+include(
+    "withaeng-api",
+    "withaeng-domain",
+    "withaeng-common",
+    "withaeng-external"
+)
+
+pluginManagement {
+    val kotlinVersion: String by settings
+    val springBootVersion: String by settings
+    val springDependencyManagementVersion: String by settings
+
+    resolutionStrategy {
+        eachPlugin {
+            when (requested.id.id) {
+                "org.jetbrains.kotlin.jvm" -> useVersion(kotlinVersion)
+                "org.jetbrains.kotlin.plugin.spring" -> useVersion(kotlinVersion)
+                "org.jetbrains.kotlin.plugin.jpa" -> useVersion(kotlinVersion)
+                "org.springframework.boot" -> useVersion(springBootVersion)
+                "io.spring.dependency-management" -> useVersion(springDependencyManagementVersion)
+            }
+        }
+    }
+}

withaeng-api/Dockerfile

@@ -0,0 +1,5 @@
+FROM eclipse-temurin:17-jre-alpine
+ENV TZ=Asia/Seoul
+ENV JAVA_OPTS="-Djava.net.preferIPv4Stack=true"
+COPY build/libs/*.jar app.jar
+ENTRYPOINT ["java", "-jar", "/app.jar"]

withaeng-api/build.gradle.kts

@@ -1,12 +1,29 @@
-tasks.bootJar {
+tasks.getByName("bootJar") {
     enabled = true
 }
 
-tasks.jar {
+tasks.getByName("jar") {
     enabled = false
 }
 
+val jjwtVersion: String by project.extra
+val swaggerVersion: String by project.extra
+
 dependencies {
     implementation(project(":withaeng-domain"))
+    implementation(project(":withaeng-common"))
+    implementation(project(":withaeng-external"))
     implementation("org.springframework.boot:spring-boot-starter-web")
+    implementation("org.springframework.boot:spring-boot-starter-security")
+    implementation("org.springframework.boot:spring-boot-starter-validation")
+
+    api("org.springframework.boot:spring-boot-starter-data-jpa")
+
+    // jwt
+    implementation("io.jsonwebtoken:jjwt-api:$jjwtVersion")
+    runtimeOnly("io.jsonwebtoken:jjwt-impl:$jjwtVersion")
+    runtimeOnly("io.jsonwebtoken:jjwt-jackson:$jjwtVersion")
+
+    // Swagger
+    implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:$swaggerVersion")
 }

withaeng-api/docker-compose.yml

@@ -0,0 +1,21 @@
+services:
+  withaeng-api:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: withaeng-api
+    ports:
+      - "8080:8080"
+    environment:
+      SPRING_PROFILES_ACTIVE: ${SPRING_PROFILES_ACTIVE}
+      DATABASE_DRIVER: ${DATABASE_DRIVER}
+      DATABASE_URL: ${DATABASE_URL}
+      DATABASE_USERNAME: ${DATABASE_USERNAME}
+      DATABASE_PASSWORD: ${DATABASE_PASSWORD}
+      WITHAENG_HOST: ${WITHAENG_HOST}
+      JWT_ISSUER: ${JWT_ISSUER}
+      JWT_SECRET_KEY: ${JWT_SECRET_KEY}
+      AWS_ACCESS_KEY: ${AWS_ACCESS_KEY}
+      AWS_SECRET_KEY: ${AWS_SECRET_KEY}
+      AWS_SES_REGION: ${AWS_SES_REGION}
+      AWS_SES_FROM: ${AWS_SES_FROM}

withaeng-api/src/main/kotlin/com/travel/withaeng/api/WithaengApplication.kt → withaeng-api/src/main/kotlin/com/withaeng/WithaengApplication.kt

@@ -1,4 +1,4 @@
-package com.travel.withaeng.api
+package com.withaeng
 
 import org.springframework.boot.autoconfigure.SpringBootApplication
 import org.springframework.boot.runApplication