[스프링] github actions에 Chat GPT 코드리뷰 기능 추가하기

https://sebang.tistory.com/51

[스프링] 도커(docker) + EC2 + github actions 배포

# This workflow will build a Java project with Gradle
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
 
# Repo Action 페이지에 나타날 이름 
name: Spring Boot & Gradle CI/CD 

# Event Trigger
# dev branch에 push 또는 pull request가 발생할 경우 동작
# branch 단위 외에도, tag나 cron 식 등을 사용할 수 있음 
on:
  push:
    branches: [ develop ]
  pull_request:
    branches: [ develop ] 

jobs:
  build:
  
    # 실행 환경 지정
    runs-on: ubuntu-latest

    # Task의 sequence를 명시한다.
    # 브랜치를와 마찬가지로 checkout을 한다.
    # 누군가 만들어 놓은 Actions를 사용하기 위해 uses 키워드 사용
    steps:
    - uses: actions/checkout@v3
        
    # push 할때마다 다시 gradle을 install하지 않기 위한 설정
    # 해당 프로젝트의 gradle값이 변경됐을 경우에만 install
    - name: Cache Gradle packages
      uses: actions/cache@v3
      with:
        path: |
          ~/.gradle/caches
          ~/.gradle/wrapper
        key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
        restore-keys: |
          ${{ runner.os }}-gradle-

    # CI 시작
    - name: Set up JDK 17
      uses: actions/setup-java@v3
      
      # with로 Actions에 값 전달
      with:
        java-version: 17
        distribution: 'temurin'

    ## create application.properties
    - name: make application.properties
      run: |
        
        # spring의 resources 경로로 이동
        cd ./src/main/resources 
        
        # application.properties 파일 생성
        touch ./application.yml
        
        touch ./application-common.yml 
        
        touch ./application-db.yml 
        
        # GitHub-Actions에서 설정한 값을 application.properties 파일에 쓰기
        echo "${{ secrets.YML_DEV }}" >> ./application.yml 
        
        echo "${{ secrets.COMMON_DEV }}" >> ./application-common.yml 
        
        echo "${{ secrets.DB_DEV }}" >> ./application-db.yml 
      shell: bash
      
       ## gradle build
    - name: Build with Gradle
      run: 
        chmod +x ./gradlew
        
        ./gradlew build
        
          
      # Spring 어플리케이션 Docker Image 빌드
      # CD 시작 
    - name: Docker build
      run: |          
          docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
          docker build --build-arg DEPENDENCY=build/dependency -t ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPO }} .
          docker push ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPO }}
          
      
      # 서버에서 Docker 이미지 실행
      # HOST_DEV = 퍼블릭 IPv4 DNS , USERNAME = ubuntu, KEY = pem 키 전체
    - name: EC2 Docker Run
      uses: appleboy/ssh-action@master
      with:
        host: ${{ secrets.HOST_DEV }}
        username: ${{ secrets.USERNAME }}
        password: ${{ secrets.KEY }}
        port: 22
        script: |
          sudo usermod -aG docker $USER
          newgrp docker
          sudo docker stop $(docker ps -a -q) 
          sudo docker rm $(docker ps -a -q)
          sudo docker pull ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPO }}
          sudo docker run -d -p 80:8080 ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_REPO }}

위 코드에서 Chat GPT 기능 추가하기

# Repo Action 페이지에 나타날 이름 
name: Spring Boot & Gradle CI/CD 

permissions:
      contents: read
      pull-requests: write

• contents: read: Action에서 레포지토리의 컨텐츠를 읽을 수 있습니다. 이 권한이 필요한 이유는 Action에서 레포지토리의 소스 코드나 설정 파일 등의 컨텐츠를 읽어서 빌드하거나 실행하는 등의 작업을 수행할 때 필요합니다.
• pull-requests: write: Action에서 Pull Request를 생성하거나 업데이트할 수 있습니다. 이 권한이 필요한 이유는 예를 들어, 릴리즈 노트를 자동으로 생성하는 Action을 만들 경우, Pull Request를 통해 변경 사항을 적용하기 때문입니다.

만약 permissions를 지정하지 않으면, 기본적으로 Action에서 레포지토리의 모든 내용을 읽을 수 있습니다. 하지만, Action이 레포지토리에 쓰기 작업을 수행하려면, 추가적인 권한이 필요할 수 있습니다. 이러한 경우에는 권한을 지정해주어야 합니다.

 

on:
  push:
    branches: [ develop ]
  pull_request:
    branches: [ develop ] 
    types: [opened, synchronize]

types: [opened, synchronize] 을 추가함으로써 Pull Request가 열리거나, 변경되었을때 workflow가 작동하도록 했습니다.

opened: 새로운 풀 리퀘스트가 열릴 때, closed: 풀 리퀘스트가 닫힐 때, reopened: 이전에 닫혔다가 다시 열릴 때, synchronize: 풀 리퀘스트가 변경되었을 때 (새로운 커밋이 푸시되었을 때)

    ## 코드리뷰  
    - name: Code Review
      uses: anc95/ChatGPT-CodeReview@main
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
        LANGUAGE: Korean

현재 가장 많은 분들이 쓰고있는 anc95/ChatGPT-CodeReview@main 입니다. 중국인 개발자가 제작한 actions라고 합니다.

GITHUB_TOKEN은 workflow가 실행될때 깃허브에서 자동으로 생성되며, OPENAI_API_KEY는 이름을 그대로 작성해 주셔야하며 아래에서 OPENAI_API_KEY 발급 방법을 설명하는것으로 마치겠습니다.

https://platform.openai.com/overview

OpenAI API

 

위 사이트를 들어가서 로그인 혹은 회원가입을 진행한 후 View API keys를 눌러줍니다.

Create new secret key를 눌러서 API keys를 발급받습니다. 발급받은후 API key를 바로 복사후 다른곳에 저장해 두시기를 바랍니다. 위 사진에서 보이듯이 발급후에는 key를 확인할수 없게됩니다.

그다음 Usage에 들어가면 사용량이 나오게 되는데 처음 API키를 발급받았다면 18$에 해당하는 양의 API 호출이 가능해집니다. 그 이후는 Chat GPT API를 구매하여 사용해야 합니다.

 

마지막으로 위에서 발급받은 키를 Secrets에 OPENAI_API_KEY라는 이름으로 만든다음 붙여넣으시면 끝입니다.