배포 목적 병합

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,19 +1,19 @@
-name: ❗ SCG Project Bug report
-description: Report bug to SCG Project
-title: "[BUG] "
-labels: ['bug', 'pending']
+name: 🐞 Bug Report
+description: Report bug to S-TOP backend
+title: "🐞 [BUG] "
+labels: ['🐞 Bug']
 body:
   - type: textarea
     attributes:
-      label: Description 📖
+      label: 📖 Description
       id: bug-description
       description: |
         발생한 버그에 대해 상세하게 설명해주세요
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Reproduction 🏗️
+      label: 🏗 Reproduction
       id: bug-reproduction
       description: |
         버그 reproduction 방법을 자세히 설명해주세요
@@ -26,23 +26,25 @@ body:
       required: true
   - type: textarea
     attributes:
-      label: Logs 🪵
+      label: 🪵 Logs
       id: bug-log
       description: |
         버그가 발생했을 때의 Log를 남겨주시면 더욱 더 해결하는 데 도움이 됩니다!🙇
       render: shell
   - type: textarea
     attributes:
-      label: Environment 🖥️
+      label: 🖥 Environment ️
       id: bug-environment
       description: |
         버그가 발생한 환경에 대해 설명해주세요 (브라우저, OS, 하드웨어 등)
   - type: checkboxes
     id: bug-checkboxes
     attributes:
-      label: CheckList ✔️
+      label: ✔️CheckList
       description: |
         Issue 올리기 전에 한 번 확인해주세요! 👍
       options:
         - label: 관련 Issue 가 이미 존재하는 지 확인해보셨나요?
-          required: true
+          required: true
+        - label: Assignees 설정
+        - label: Labels 설정

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,30 +1,33 @@
-name: 🚀 SCG Project New Feature Request
-description: Propose new feature to SCG Project
-title: "🚀 "
-labels: ['enhancement', 'pending']
+name: 🚀 New Feature Request
+description: Propose new feature to S-TOP backend
+title: "🚀 [FEAT] "
+labels: ['🚀 Feature']
 body:
   - type: textarea
     attributes:
-      label: Describe Existing Problem ❓
+      label: ❓ Describe Existing Problem
       id: feature-problem
       description: |
         해결하려는 문제를 자세히 설명해주세요!
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Describe Solution 💸
+      label: ✅ Describe Solution
       id: feature-solution
       description: |
         위의 문제를 해결하기 위해 어떤 기능을 추가하고 싶은 지 설명해주세요!
+      value: |
+        - [ ] task 1
+        - [ ] task 2
     validations:
       required: true
   - type: textarea
     attributes:
-      label: Describe Alternatives 💼
-      id: feature-solution
+      label: 📍 More
+      id: feature-more
       description: |
-        위의 문제를 해결하기 위해 고민한 다른 방법들에 대해서도 자유롭게 서술해주세요!
+        기타 참고할만한 사항들을 작성해주세요!
   - type: checkboxes
     id: feature-checkboxes
     attributes:
@@ -33,4 +36,6 @@ body:
         Issue 올리기 전에 한 번 확인해주세요! 👍
       options:
         - label: 관련 Issue 가 이미 존재하는 지 확인해보셨나요?
-          required: true
+          required: true
+        - label: Assignees 설정
+        - label: Labels 설정

.github/pull_request_template.md

@@ -1,18 +1,18 @@
 작성자: @github_nickname
 
-close/resolve/fix #{이슈 번호 기입}
+#{이슈 번호 기입}
 
 ## 체크 리스트
 
 - [ ] 적절한 제목으로 수정했나요?
 - [ ] 상단에 이슈 번호를 기입했나요?
 - [ ] Target Branch를 올바르게 설정했나요?
-- [ ] Label을 알맞게 설정했나요?
+- [ ] Reviewers/Assignees/Labels을 알맞게 설정했나요?
 
 ## 작업 내역
 
 - 작업한 내용을 간략하게 작성해주세요.
 
 ## 비고
 
-- 참고 사항을 적어주세요. 코드 리뷰하는 사람이 참고해야 하는 내용을 자유로운 형식으로 적을 수 있습니다.
+- 참고 사항을 적어주세요. 코드 리뷰하는 사람이 참고해야 하는 내용을 자유로운 형식으로 적을 수 있습니다.

.github/workflows/CD.yml → .github/workflows/CD-prod.yml

@@ -1,11 +1,12 @@
-name: CD
+name: CD-PROD
 
 on:
   push:
     branches: ["main"]
+  workflow_dispatch:
 env:
   dockerimage_tag: ${{ github.sha }}
-  dockerimage_name: jcy0308/stop
+  dockerimage_name: jcy0308/stop-be-prod
 
 jobs:
   build:
@@ -93,4 +94,4 @@ jobs:
           git commit -am "Update image tag"
           git push -u origin main
       - name: --------------- Clean Up ---------------
-        run: echo "Clean Up"
+        run: echo "Clean Up"

.github/workflows/CD-qa.yml

@@ -0,0 +1,96 @@
+name: CD
+
+on:
+  push:
+    branches: ["develop"]
+env:
+  dockerimage_tag: ${{ github.sha }}
+  dockerimage_name: jcy0308/stop-be-qa
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      id-token: write
+    steps:
+      - name: --------------- Code Repo ---------------
+        run: echo "Code Repo"
+      - name: Code Repo 불러오기
+        uses: actions/checkout@v4
+
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'corretto'
+
+      - name: Set up Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Gradle 권한 부여
+        run: chmod +x gradlew
+
+      - name: Gradle build
+        run: ./gradlew build --exclude-task test --exclude-task asciidoctor
+
+      - name: Docker 준비(1/4) - 메타데이터 생성
+        id: meta
+        uses: docker/metadata-action@v5.5.1
+        with:
+          images: |
+            ${{ env.dockerimage_name }}
+          tags: |
+            ${{ env.dockerimage_tag }}
+            latest
+          flavor: |
+            latest=true
+      - name: Docker 준비(2/4) - QEMU 설정
+        uses: docker/setup-qemu-action@v3
+      - name: Docker 준비(3/4) - buildx 설정
+        uses: docker/setup-buildx-action@v3
+      - name: Docker 준비(4/4) - 레지스트리 로그인
+        uses: docker/login-action@v3.0.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCkER_PASSWORD }}
+      - name: Docker 이미지 빌드+푸시
+        id: build-and-push
+        uses: docker/build-push-action@v5.1.0
+        with:
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          provenance: false
+
+      - name: --------------- Config Repo ---------------
+        run: echo "[Config Repo]"
+      - name: Config Repo 불러오기
+        uses: actions/checkout@v4
+        with:
+          repository: SystemConsultantGroup/S-TOP-config
+          ref: main
+          token: ${{ secrets.ACTION_TOKEN }}
+          path: S-TOP-config
+      - name: Kustomize 준비
+        uses: imranismail/setup-kustomize@v2.0.0
+      - name: Config Repo 이미지 값 업데이트 (Kustomize)
+        run: |
+          cd S-TOP-config/overlays/qa/be/
+          kustomize edit set image ${{ env.dockerimage_name }}:${{ env.dockerimage_tag }}
+          cat kustomization.yaml
+      - name: Config Repo 변경사항 푸시
+        run: |
+          cd S-TOP-config
+          git config --global user.email "jcy030896@naver.com"
+          git config --global user.name "chanyeong"
+          git commit -am "Update image tag"
+          git push -u origin main
+      - name: --------------- Clean Up ---------------
+        run: echo "Clean Up"

.github/workflows/CI.yml

@@ -2,9 +2,11 @@ name: Java CI with Gradle
 
 on:
   pull_request:
-    branches: ["main"]
+    branches: ["main", "develop"]
   workflow_dispatch:
 
+permissions: write-all
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -35,7 +37,18 @@ jobs:
 #        with:
 #          redis-version: "7.2.5"
 #          redis-port: 6379
+      - name: set Config
+        run: |
+          echo "${{ secrets.OAUTH_YML }}" | base64 --decode > src/main/resources/application-oauth.yml
+          echo "${{ secrets.MINIO_YML }}" | base64 --decode > src/main/resources/application-minio.yml
+          echo "${{ secrets.NOTION_YML }}" | base64 --decode > src/main/resources/application-notion.yml
+          echo "${{ secrets.EMAIL_YML }}" | base64 --decode > src/main/resources/application-email.yml
+          echo "${{ secrets.COMMON_YML }}" | base64 --decode > src/main/resources/application-common.yml
+          find src
 
+      - name: gradlew 권한 부여
+        run: chmod +x gradlew
+
       - name: Build with Gradle Wrapper
         run: ./gradlew build
 
@@ -49,9 +62,9 @@ jobs:
 #          min-coverage-overall: 50
 #          min-coverage-changed-files: 50
 #          update-comment: true
-
-#      - name: SonarQube test and analyze
-#        env:
-#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-#          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
-#        run: ./gradlew test sonar --info --stacktrace
+      - name: Publish Test Results
+        uses: mikepenz/action-junit-report@v4.3.1
+        if: success() || failure()
+        with:
+          report_paths: '**/build/test-results/**/*.xml'
+          token: ${{secrets.JUNIT_TOKEN}}

.gitignore

@@ -35,3 +35,11 @@ out/
 
 ### VS Code ###
 .vscode/
+
+/src/main/resources/application-oauth.yml
+/src/main/resources/application-minio.yml
+/src/main/resources/application-dev.yml
+/src/main/resources/application-email.yml
+/src/main/resources/application-notion.yml
+
+.DS_Store

README.md

@@ -1 +1,3 @@
-# S-TOP-backend
+# S-TOP backend
+
+[S-TOP Rest Docs](https://systemconsultantgroup.github.io/S-top-backend/src/main/resources/static/docs/index.html)

build.gradle

@@ -35,11 +35,13 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-validation'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 	implementation 'org.springframework.boot:spring-boot-starter-aop'
+	implementation 'io.hypersistence:hypersistence-utils-hibernate-60:3.8.1'
 	compileOnly 'org.projectlombok:lombok'
 	annotationProcessor 'org.projectlombok:lombok'
 	runtimeOnly 'com.mysql:mysql-connector-j'
 	annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
+	developmentOnly 'org.springframework.boot:spring-boot-devtools'
 
 	//auth
 	implementation 'io.jsonwebtoken:jjwt-api:0.11.5'
@@ -54,9 +56,33 @@ dependencies {
 	//metrics
 	implementation 'io.micrometer:micrometer-registry-prometheus'
 
+    testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+
+    //email
+    implementation 'org.springframework.boot:spring-boot-starter-mail'
+
+    //thymeleaf(for email service)
+    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
+    implementation 'nz.net.ultraq.thymeleaf:thymeleaf-layout-dialect'
 	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+
+	// apache.poi for excel
+	implementation 'org.apache.poi:poi-ooxml:5.2.2'
+	implementation 'org.apache.poi:poi:5.2.2'
+
+	// minIO
+	implementation "io.minio:minio:8.5.11"
+
+	// queryDSL
+	implementation 'com.querydsl:querydsl-core'
+	implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
+	annotationProcessor("com.querydsl:querydsl-apt:5.0.0:jakarta") // querydsl JPAAnnotationProcessor 사용 지정
+	annotationProcessor("jakarta.persistence:jakarta.persistence-api") // java.lang.NoClassDefFoundError(javax.annotation.Entity) 발생 대응
+	annotationProcessor("jakarta.annotation:jakarta.annotation-api") // java.lang.NoClassDefFoundError (javax.annotation.Generated) 발생 대응
 }
 
+
+
 tasks.named('test') {
 	outputs.dir snippetsDir
 	useJUnitPlatform()
@@ -87,8 +113,13 @@ tasks.named('asciidoctor') {
 build {
 	dependsOn copyDocument
 }
+
 allprojects {
 	repositories {
 		maven { url 'https://jitpack.io'}
 	}
-}
+}
+
+
+def querydslDir = "build/generated/querydsl"
+