깃헙 액션으로 CI/CD 구축방법

깃헙 액션을 선택한 이유

깃헙과 통합되어 있어 별다른 복잡한 절차 없이 사용할 수 있다는 장점이 있습니다.
작은 프로젝트를 진행할때 설정에 관한 리소스 낭비가 적습니다.
비동기 CI/CD가 가능하므로 빠른 배포가 가능합니다.
결정적으로 깃허브 액션이 아닌 Jenkins는 러닝커브가 높아 프로젝트 완성이 최우선인 상황에 적절하지 않다고 판단했습니다.

흐름도

Untitled

전체 yml 파일

# 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
      if: contains(github.ref, 'develop') # branch가 develop 때
      run: |
        
        # spring의 resources 경로로 이동
        cd ./src/main/resources 
        
        # application.properties 파일 생성
        touch ./application.properties 
        
        # GitHub-Actions에서 설정한 값을 application.properties 파일에 쓰기
        echo "${{ secrets.PROPERTIES_DEV }}" >> ./application.properties 
      shell: bash
      
       ## gradle build
    - name: Build with Gradle
      run: 
        chmod +x ./gradlew
        
        ./gradlew build

      # Spring 어플리케이션 Docker Image 빌드
      # CD 시작
    - name: Docker build
      if: contains(github.ref, 'develop')
      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 키 전체( 만약 안될시 ubuntu에서 password 생성)
    - name: EC2 Docker Run
      uses: appleboy/ssh-action@master
      if: contains(github.ref, 'develop')
      with:
        host: ${{ secrets.HOST_DEV }}
        username: ${{ secrets.USERNAME }}
        password: ${{ secrets.KEY }}
        port: 22
        script: |
          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 }}

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

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

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

    # Task의 sequence를 명시한다.
    # 브랜치를와 마찬가지로 checkout을 한다.
    # 누군가 만들어 놓은 Actions를 사용하기 위해 uses 키워드 사용
    steps:
    - uses: actions/checkout@v3

ci-cd-test라는 브랜치에 push나 pull_request가 발생하면 workflow를 실행합니다.

checkout은 깃의 checkout과 마찬가지로 특정 브랜치로 이동하는 것입니다. 브랜치로 이동할때 특정 브랜치에 올려져있는 코드들을 CI 서버로 내려받는 일련의 과정입니다.

# 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-

공부 필요.

## create application.properties
    - name: make application.properties
      if: contains(github.ref, 'develop') # branch가 develop 때
      run: |
        
        # spring의 resources 경로로 이동
        cd ./src/main/resources 
        
        # application.properties 파일 생성
        touch ./application.properties 
        
        # GitHub-Actions에서 설정한 값을 application.properties 파일에 쓰기
        echo "${{ secrets.PROPERTIES_DEV }}" >> ./application.properties 
      shell: bash