[C팀] 백엔드파트 코드리뷰용 PR

.dockerignore

@@ -0,0 +1,3 @@
+.git/
+.gitignore/
+.idea/

.github/ISSUE_TEMPLATE/issue_template.md

@@ -0,0 +1,20 @@
+---
+name: "\bIssue 생성 템플릿"
+about: 해당 Issue 생성 템플릿을 통하여 Issue를 생성해주세요.
+title: 'Feat: Issue 제목'
+labels: ''
+assignees: ''
+
+---
+
+### 📝 Description
+
+- 구현할 내용 1
+- 구현할 내용 2
+
+---
+
+### 📝 Todo
+
+- [ ] 구현할 내용 1
+- [ ] 구현할 내용 2

.github/pull_request_template.md

@@ -0,0 +1,35 @@
+## ✅ PR 유형
+어떤 변경 사항이 있었나요?
+
+- [ ] 새로운 기능 추가
+- [ ] 버그 수정
+- [ ] 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
+- [ ] 코드 리팩토링
+- [ ] 주석 추가 및 수정
+- [ ] 문서 수정
+- [ ] 빌드 부분 혹은 패키지 매니저 수정
+- [ ] 파일 혹은 폴더명 수정
+- [ ] 파일 혹은 폴더 삭제
+
+---
+
+## 📝 작업 내용
+이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)
+
+- 작업한 내용 1
+- 작업한 내용 2
+
+---
+
+## ✏️ 관련 이슈
+본인이 작업한 내용이 어떤 Issue Number와 관련이 있는지만 작성해주세요
+
+ex)
+- Fixes : #00 (수정중인 이슈)
+- Resolves : #100 (무슨 이슈를 해결했는지)
+- Ref : #00 #01 (참고할 이슈)
+- Related to : #00 #01 (해당 커밋과 관려)
+
+---
+
+## 🎸 기타 사항 or 추가 코멘트

.github/workflows/deploy.yml

@@ -0,0 +1,115 @@
+name: Cnergy Backend CI/CD
+
+on:
+  push:
+    branches: [dev]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      - name: Set up SSH key
+        uses: webfactory/[email protected]
+        with:
+          ssh-private-key: ${{ secrets.NCP_SSH_PRIVATE_KEY }}
+
+      - name: Download GeoLite2-City Database
+        run: |
+          mkdir -p src/main/resources/maxmind
+
+          curl -L -u ${{ secrets.GEOIP_ACCOUNT_ID }}:${{ secrets.GEOIP_LICENSE }} \
+          'https://download.maxmind.com/app/geoip_download?edition_id=GeoLite2-City&suffix=tar.gz&license_key=${{ secrets.GEOIP_LICENSE }}' \
+          -o GeoLite2-City.tar.gz
+
+          tar -xzf GeoLite2-City.tar.gz --wildcards --strip-components 1 -C src/main/resources/maxmind '*.mmdb'
+
+          rm GeoLite2-City.tar.gz
+
+      - name: Gradle 캐시 적용
+        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: JDK 17 세팅
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: YML 파일 세팅
+        env:
+          APPLICATION_PROPERTIES: ${{ secrets.APPLICATION_PROPERTIES }}
+          TEST_APPLICATION_PROPERTIES: ${{ secrets.TEST_APPLICATION_PROPERTIES }}
+        run: |
+          cd ./src
+          rm -rf main/resources/application.yml
+          mkdir -p test/resources
+          echo "$APPLICATION_PROPERTIES" > main/resources/application.yml
+          echo "$TEST_APPLICATION_PROPERTIES" > test/resources/application.yml
+
+      - name: gradlew 권한 부여
+        run: chmod +x gradlew
+
+      - name: 테스트 수행
+        run: ./gradlew test
+
+      - name: 스프링부트 빌드
+        run: ./gradlew build
+
+      - name: Docker Buildx 세팅
+        uses: docker/setup-buildx-action@v3
+
+      - name: NCP 레지스트리 로그인
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ secrets.NCP_CONTAINER_REGISTRY }}
+          username: ${{ secrets.NCP_ACCESS_KEY }}
+          password: ${{ secrets.NCP_SECRET_KEY }}
+
+      - name: 도커 이미지 빌드 후 푸시
+        if: success()
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ secrets.NCP_CONTAINER_REGISTRY }}/cnergy-backend:${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
+          platforms: linux/amd64,linux/arm64
+
+      - name: Docker Compose 파일 NCP 서버로 전송
+        run: scp -o StrictHostKeyChecking=no -P ${{ secrets.NCP_PORT }} docker-compose.yml ${{ secrets.NCP_USERNAME }}@${{ secrets.NCP_HOST }}:./
+
+      - name: NCP 접속 후 배포
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.NCP_HOST }}
+          username: ${{ secrets.NCP_USERNAME }}
+          password: ${{ secrets.NCP_PASSWORD }}
+          port: ${{ secrets.NCP_PORT }}
+          script: |
+            echo "NCP_CONTAINER_REGISTRY=${{ secrets.NCP_CONTAINER_REGISTRY }}" > .env
+            echo "GITHUB_SHA=${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}" >> .env
+            echo "RABBITMQ_DEFAULT_USER=${{ secrets.RABBITMQ_DEFAULT_USER }}" >> .env
+            echo "RABBITMQ_DEFAULT_PASS=${{ secrets.RABBITMQ_DEFAULT_PASS }}" >> .env
+            sudo chmod +x ./deploy.sh
+            ./deploy.sh

.gitignore

@@ -35,3 +35,8 @@ out/
 
 ### VS Code ###
 .vscode/
+
+### Configuration ###
+src/main/resources/application-*.yml
+src/main/resources/maxmind
+src/test/resources/application.yml

Dockerfile

@@ -0,0 +1,9 @@
+FROM openjdk:17.0.1-jdk-slim
+
+WORKDIR /app
+
+COPY ./build/libs/backend-0.0.1-SNAPSHOT.jar /app/backend.jar
+
+EXPOSE 8080
+ENTRYPOINT ["java"]
+CMD ["-jar", "backend.jar"]

Dockerfile-local

@@ -0,0 +1,17 @@
+FROM gradle:8.10.1-jdk17 AS build
+
+WORKDIR /app
+
+COPY . /app
+
+RUN gradle clean build -x test --no-daemon
+
+FROM openjdk:17.0.1-jdk-slim
+
+WORKDIR /app
+
+COPY --from=build /app/build/libs/*.jar /app/backend.jar
+
+EXPOSE 8080
+ENTRYPOINT ["java"]
+CMD ["-jar", "backend.jar"]