[KOBG-4] 기초 세팅 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

yerim123456 merged 22 commits into develop from feature/KOBG-4/initial-setting

Aug 17, 2025

.gitattributes

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    # --- 개행 문자 규칙 ---
+    # 모든 텍스트 파일은 LF로 통일
+    # checkstyle 규칙 적용을 위한 설정 (window 개행 문자 문제)
+    * text=auto eol=lf
+    # --- 예외 규칙 ---
+    # Windows 환경에서만 CRLF가 꼭 필요한 경우 (.bat 파일)
+    *.bat text eol=crlf
+    # --- 파일 종류 ---
+    # 이미지/바이너리 파일은 변환 금지
+    *.png binary
+    *.jar binary

.github/pull_request_template.md

-Original file line number
+Diff line change
@@ -0,0 +1,35 @@
+    ## 🔑 JIRA 이슈 키
+    <!-- KOBR-123 한국어 레슨 별 조회 API -->
+    ---
+    ## ✒ 진행한 작업
+    - [x] 진행한 작업
+    - [x] 진행한 작업
+    - [x] 진행한 작업
+    ---
+    ## 💡 생겼던 문제 및 해결법
+️⃣ 요약
+    - 문제:
+    - 해결:
+    ---
+    ## 📢 아쉬운 부분 및 개선점
+    - ...
+    ---
+    ## 📚 개발에 참고한 자료 및 포인트
+    - 참고한 부분 요약 및 포인트
+        - link
+    ---

.github/workflows/cd-pipeline.yml

-Original file line number
+Diff line change
@@ -0,0 +1,59 @@
+    name: Java CD with Gradle
+    on:
+      push:
+        branches:
+          - main
+          - feature/KOBG-4/initial-setting
+    permissions:
+      contents: read
+    jobs:
+      deploy:
+        runs-on: ubuntu-latest
+        steps:
+          - name: 🔄 체크아웃 코드
+            uses: actions/checkout@v4
+          - name: ☕ JDK 17 설치
+            uses: actions/setup-java@v4
+            with:
+              java-version: 17
+              distribution: 'corretto'
+          - name: 📝 application.yml 생성
+            run: |
+              cd ./src/main/resources
+              touch ./application.yml
+              echo "${{ secrets.PROPERTIES }}" > ./application.yml
+            shell: bash
+          - name: 🔧 빌드 권한 부여
+            run: chmod +x gradlew
+          - name: 🏗️ 프로젝트 jar 파일 제작
+            run: |
+              chmod +x gradlew
+              ./gradlew bootJar
+          - name: 🐳 Docker 로그인
+            run: docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
+          - name: 🏗️ Docker 이미지 빌드 및 푸시
+            run: |
+              docker build -t ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPO }} .
+              docker push ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPO }}
+          - name: 🚀 EC2에 프로젝트 전송 및 배포
+            uses: appleboy/ssh-action@master
+            with:
+              host: ${{ secrets.HOST }}
+              username: ${{ secrets.USERNAME }}
+              key: ${{ secrets.KEY }}
+              script: |
+                cd /home/ubuntu/app
+                export IMAGE_TAG=${{ github.sha }} sudo docker compose up -d --pull always
+                sudo docker ps
+                sudo docker image prune -f

.github/workflows/ci-pipeline.yml

-Original file line number
+Diff line change
@@ -0,0 +1,61 @@
+    name: Java CI with Gradle
+    on:
+      pull_request:
+        branches:
+          - main
+          - develop
+    permissions:
+      contents: read
+      checks: write
+      pull-requests: write
+    jobs:
+      build:
+        runs-on: ubuntu-latest
+        steps:
+          - name: 🔄 체크아웃
+            uses: actions/checkout@v4
+          - name: ☕ JDK 17 설치
+            uses: actions/setup-java@v4
+            with:
+              java-version: 17
+              distribution: 'corretto'
+          - name: 📝 application.yml 생성
+            run: |
+              cd ./src/main/resources
+              touch ./application.yml
+              echo "${{ secrets.PROPERTIES }}" > ./application.yml
+            shell: bash
+          - name: 🚀 Redis 실행
+            uses: supercharge/redis-github-action@1.1.0
+            with:
+              redis-version: latest
+          - name: 🔧 빌드 권한 부여
+            run: chmod +x gradlew
+          - name: 🛠️ 테스트 프로파일 설정
+            run: echo "SPRING_PROFILES_ACTIVE=test" >> $GITHUB_ENV
+          - name: 🏗️ 프로젝트 빌드
+            run: ./gradlew clean build
+          - name: 📊 자코코 리포트 작성
+            uses: madrapps/jacoco-report@v1.6.1
+            with:
+              title: 📊 Jacoco Test Coverage
+              paths: ${{ github.workspace }}/**/build/reports/jacoco/test/jacocoTestReport.xml
+              token: ${{ secrets.GITHUB_TOKEN }}
+              min-coverage-overall: 80
+              min-coverage-changed-files: 0
+          - name: ✅ 테스트 리포트 작성
+            uses: mikepenz/action-junit-report@v4
+            with:
+              report_paths: '**/build/test-results/test/TEST-*.xml'

.gitignore

-Original file line number
+Diff line change
@@ -0,0 +1,40 @@
+    HELP.md
+    .gradle
+    build/
+    !gradle/wrapper/gradle-wrapper.jar
+    !**/src/main/**/build/
+    !**/src/test/**/build/
+    ### STS ###
+    .apt_generated
+    .classpath
+    .factorypath
+    .project
+    .settings
+    .springBeans
+    .sts4-cache
+    bin/
+    !**/src/main/**/bin/
+    !**/src/test/**/bin/
+    ### IntelliJ IDEA ###
+    .idea
+    *.iws
+    *.iml
+    *.ipr
+    out/
+    !**/src/main/**/out/
+    !**/src/test/**/out/
+    ### NetBeans ###
+    /nbproject/private/
+    /nbbuild/
+    /dist/
+    /nbdist/
+    /.nb-gradle/
+    ### VS Code ###
+    .vscode/
+    ### Secrets ###
+    .application.properties

Dockerfile

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    FROM openjdk:17-jdk
+    LABEL authors="yerim"
+    ARG JAR_FILE=build/libs/*SNAPSHOT.jar
+    COPY ${JAR_FILE} /app.jar
+    ENTRYPOINT ["java","-jar","/app.jar"]

build.gradle

-Original file line number
+Diff line change
@@ -0,0 +1,73 @@
+    plugins {
+        id 'java'
+        id 'checkstyle'
+        id 'jacoco'
+        id 'org.springframework.boot' version '3.5.4'
+        id 'io.spring.dependency-management' version '1.1.7'
+    }
+    group = 'com.edu'
+    version = '0.0.1-SNAPSHOT'
+    java {
+        toolchain {
+            languageVersion = JavaLanguageVersion.of(17)
+        }
+    }
+    configurations {
+        compileOnly {
+            extendsFrom annotationProcessor
+        }
+    }
+    repositories {
+        mavenCentral()
+    }
+    dependencies {
+        // spring-boot-starter
+        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-data-redis'
+        // Swagger
+        implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.8'
+        // lombok
+        compileOnly 'org.projectlombok:lombok'
+        annotationProcessor 'org.projectlombok:lombok'
+        // mysql
+        runtimeOnly 'com.mysql:mysql-connector-j'
+        // test
+        testImplementation 'org.springframework.boot:spring-boot-starter-test'
+        testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+        testImplementation 'org.mockito:mockito-core:5.18.0'
+        testImplementation 'org.mockito:mockito-junit-jupiter:5.18.0'
+    }
+    compileJava.options.encoding = 'UTF-8'
+    compileTestJava.options.encoding = 'UTF-8'
+    checkstyle {
+        configFile = file("checkstyle/naver-checkstyle-rules.xml")
+        configProperties = ["suppressionFile": file("checkstyle/naver-checkstyle-suppressions.xml")]
+    }
+    jacoco {
+        toolVersion = '0.8.11'
+    }
+    jacocoTestReport {
+        reports {
+            html.required = true
+            xml.required = true
+        }
+    }
+    tasks.named('test') {
+        useJUnitPlatform()
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[KOBG-4] 기초 세팅 #1

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!