Merge pull request #6 from YAPP-Github/ci/actions-auto

[Ci] 소나 클라우드, 인프라 변경 감지 추가

Author: lvalentine6

.github/pull-request-template.md

@@ -1,32 +1,5 @@
-## 🚀 개요
+## ✨ 개요
 
-<!-- 변경 사항 및 관련 이슈에 대해 간단하게 작성해주세요. 어떻게보다 무엇을 왜 수정했는지 설명해주세요. -->
+## 🧾 관련 이슈
 
-## 🧾 관련 이슈 (Jira 연동 예정)
-
-<!-- JIRA 이슈 키를 정확히 작성해주세요. 예: PROJ-123 -->
-Jira Issue: `PROJ-123`
-
-## 📗 유형
-
-- [ ] 새로운 기능 추가
-- [ ] 버그 수정
-- [ ] 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
-- [ ] 코드 리팩토링
-- [ ] 주석 추가 및 수정
-- [ ] 문서 수정
-- [ ] 테스트 추가, 테스트 리팩토링
-- [ ] 빌드 부분 혹은 패키지 매니저 수정
-- [ ] 파일 혹은 폴더명 수정
-- [ ] 파일 혹은 폴더 삭제
-- [ ] CI/CD 설정 수정
-- [ ] 의존성 버전 변경 / 업데이트
-
-## 🔎 상세 내용
-
-## ✅ Checklist
-
-PR이 다음 요구 사항을 충족하는지 확인하세요.
-
-- [ ] 커밋 메시지 컨벤션에 맞게 작성했습니다.
-- [ ] 변경 사항에 대한 테스트를 했습니다.
+## 🔍 참고 사항 (선택)

.github/workflows/notify-discord-noti.yml

@@ -2,12 +2,14 @@ name: Notify Discord on `/noti` Comment
 
 on:
   issue_comment:
-    types: [created]
+    types: [ created ]
 
 jobs:
   notify-on-noti-comment:
     if: github.event.issue.pull_request
     runs-on: ubuntu-latest
+    env:
+      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
     steps:
       - name: Check for `/noti` keyword and send Discord notification
         run: |
@@ -16,12 +18,12 @@ jobs:
           AUTHOR="${{ github.event.comment.user.login }}"
 
           if echo "$COMMENT_BODY" | grep -q "/noti"; then
-            CONTENT="📣 알림 요청이 감지되었습니다!\n🔗 ${PR_URL}\n🙋 작성자: ${AUTHOR}\n💬 댓글: ${COMMENT_BODY}"
+            CONTENT=$(printf "📣 알림 요청이 감지되었습니다!\n🔗 %s\n🙋 작성자: %s\n💬 댓글: %s" "$PR_URL" "$AUTHOR" "$COMMENT_BODY")
 
             curl -H "Content-Type: application/json" \
                  -X POST \
-                 -d "{\"content\": \"${CONTENT}\"}" \
-                 ${{ secrets.DISCORD_WEBHOOK }}
+                 -d "$(jq -n --arg content "$CONTENT" '{content: $content}')" \
+                 "$DISCORD_WEBHOOK"
           else
             echo "No /noti found. Skipping notification."
           fi

.github/workflows/notify-discord-pr.yml

@@ -1,5 +1,3 @@
-name: Notify Discord on PR or Review
-
 on:
   pull_request:
     types: [ opened ]
@@ -10,7 +8,8 @@ jobs:
   notify-discord:
     runs-on: ubuntu-latest
     steps:
-      - name: Send Discord Webhook
+      - name: Send Discord Webhook, Skip if review is just a comment
+        if: github.event.review.state != 'commented'
         run: |
           PR_URL="https://github.com/${{ github.repository }}/pull/${{ github.event.pull_request.number || github.event.pull_request_review.pull_request.number }}"
           AUTHOR="${{ github.event.pull_request.user.login || github.event.review.user.login }}"

.github/workflows/sonarcloud.yml

@@ -0,0 +1,38 @@
+name: sonarCloud
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Java
+        uses: actions/setup-java@v3
+        with:
+          java-version: 21
+          distribution: 'temurin'
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+
+      - name: Cache SonarCloud packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
+
+      - name: Run tests and SonarCloud scan
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: ./gradlew test jacocoTestReport sonar --info

build.gradle

@@ -7,6 +7,10 @@ plugins {
     // Rest Docs & Swagger UI
     id 'com.epages.restdocs-api-spec' version '0.18.2'
     id 'org.hidetake.swagger.generator' version '2.18.2'
+
+    // Jacoco, sonarcloud
+    id 'jacoco'
+    id("org.sonarqube") version "6.2.0.5505"
 }
 
 group = 'baegam'
@@ -18,6 +22,22 @@ java {
     }
 }
 
+jacoco {
+    toolVersion = "0.8.12"
+}
+
+sonarqube {
+    properties {
+        property "sonar.projectKey", "baegam_timeeat"
+        property "sonar.organization", "baegam"
+        property "sonar.host.url", "https://sonarcloud.io"
+        property 'sonar.sourceEncoding', 'UTF-8'
+        property 'sonar.java.coveragePlugin', 'jacoco'
+        property "sonar.coverage.jacoco.xmlReportPaths",
+                layout.buildDirectory.file("reports/jacoco/test/jacocoTestReport.xml").get().asFile.path
+    }
+}
+
 configurations {
     compileOnly {
         extendsFrom annotationProcessor
@@ -65,6 +85,21 @@ bootJar {
 tasks.named('test', Test) {
     outputs.dir snippetsDir
     useJUnitPlatform()
+    finalizedBy tasks.jacocoTestReport
+}
+
+tasks.named('jacocoTestReport', JacocoReport) {
+    dependsOn test
+    reports {
+        xml.required.set(true)
+        html.required.set(true)
+    }
+    sourceDirectories.setFrom(files(sourceSets.main.allSource.srcDirs))
+    classDirectories.setFrom(files(sourceSets.main.output))
+
+    executionData.setFrom(
+            layout.buildDirectory.file("jacoco/test.exec").map { it.asFile }
+    )
 }
 
 generateSwaggerUI {
@@ -81,10 +116,10 @@ generateSwaggerUI {
 
 openapi3 {
     servers = [ // 서버 상황에 맞춰 추가 예정
-            {
-                url = "http://localhost:8080"
-                description = "Local Server"
-            }
+                {
+                    url = "http://localhost:8080"
+                    description = "Local Server"
+                }
     ]
     title = "백암 순대 API" // 수정 예정
     description = "백암 순대 API" // 수정 예정