[싹틔움] 11/05 개발일지 배포 : Github Actions 를 활용한 CI/CD 자동화 WorkFlow

🌱 CI/CD Workflow

CICD.yml

name: CI/CD

on:
  pull_request:
    branches: ["main"]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Install JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'

      - name: Build with Gradle
        run: |
          chmod +x ./gradlew
          ./gradlew clean build -x test

      - name: Login to DockerHub
        uses: docker/login-action@v1
        with:
          username: ${{ secrets.DOCKERHUB_USERNAME }}
          password: ${{ secrets.DOCKERHUB_TOKEN }}

      - name: Build Docker Image
        run: docker build -t ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1 .

      - name: Push Docker Image
        run: docker push ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1

  deploy:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Deploy to Server
        uses: appleboy/ssh-action@master
        with:
          username: ubuntu
          host: ${{ secrets.SSAKTIUM_SERVER_IP }}
          key: ${{ secrets.EC2_SSH_KEY }}
          script_stop: true
          script: |
            # Pull the latest image from DockerHub
            sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1
            
            # Stop and remove the existing container if it exists
            if [ "$(sudo docker ps -q -f name=daegyuhan-ssak)" ]; then
              sudo docker stop daegyuhan-ssak
            fi
            
            if [ "$(sudo docker ps -aq -f status=exited -f name=daegyuhan-ssak)" ]; then
              sudo docker rm daegyuhan-ssak
            fi
            
            # Run the new container
            sudo docker run -d --name daegyuhan-ssak -p 8080:8080 ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1

---

on:
  pull_request:
    branches: ["main"]

 

📚 main 브랜치에 pull request 가 일어날 때만 실행

---

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Install JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'temurin'

 

📚 ubuntu 최신 버전에서 실행시키고, JDK 17 버전으로 실행하겠다는 말이다.

웬만하면 버전은 본인의 프로젝트 실행 환경과 동일하게 가주는 게 좋다.

---

- name: Build with Gradle
  run: |
    chmod +x ./gradlew
    ./gradlew clean build -x test

 

📚 Gradle 환경이기 때문에 똑같이 맞춰줬다.

clean 을 한 번 하고 build 를 해서 싹 갈아주고, -x test 옵션을 써서 우선 test 를 돌리는 과정을 생략했다.

: 프로젝트 진행 속도를 위해서 우선 이렇게 진행

---

- name: Login to DockerHub
  uses: docker/login-action@v1
  with:
    username: ${{ secrets.DOCKERHUB_USERNAME }}
    password: ${{ secrets.DOCKERHUB_TOKEN }}

- name: Build Docker Image
  run: docker build -t ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1 .

- name: Push Docker Image
  run: docker push ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1

 

📚 내 프로젝트의 jar 파일을 Docker 이미지로 만들어서 Docker Hub 에 올려놓기 위한 코드이다.

Docker Hub 에 로그인을 한다음에 기존에 생성되어있는 Repository 에 등록되어있는 이미지와 버전에 맞춰서 Build, Push 를 진행한다.

DOCKERHUB_TOKEN 은 Docker Hub 에 접속해서 받을 수 있다.

 

Dockerfile

FROM amazoncorretto:17-alpine-jdk
EXPOSE 8080
ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar
ENTRYPOINT ["java", "-jar", "app.jar"]

 

---

deploy:
  needs: build
  runs-on: ubuntu-latest
  steps:
    - name: Deploy to Server
      uses: appleboy/ssh-action@master
      with:
        username: ubuntu
        host: ${{ secrets.SSAKTIUM_SERVER_IP }}
        key: ${{ secrets.EC2_SSH_KEY }}
        script_stop: true

 

📚 deploy 과정이다. 똑같이 환경은 ubuntu 최신 버전으로 해줬고, 내 인스턴스의 서버 IP 와 SSH_KEY 를 입력함으로써, 내 인스턴스 SSH 에 접속을 시켰다.

---

script: |
  # Pull the latest image from DockerHub
  sudo docker pull ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1
  
  # Stop and remove the existing container if it exists
  if [ "$(sudo docker ps -q -f name=daegyuhan-ssak)" ]; then
    sudo docker stop daegyuhan-ssak
  fi
  
  if [ "$(sudo docker ps -aq -f status=exited -f name=daegyuhan-ssak)" ]; then
    sudo docker rm daegyuhan-ssak
  fi
  
  # Run the new container
  sudo docker run -d --name daegyuhan-ssak -p 8080:8080 ${{ secrets.DOCKERHUB_USERNAME }}/ssak:v1

 

📚 맨 위에서 build 단계에서 push 했던 내 Docker Hub 의 이미지를 Pull 로 당겨온다.

 

📚 기존에 실행되고 있는 컨테이너를 stop 하고, remove 한다.

 

📚 Pull 로 당겨온 새 이미지를 8080 포트로 새로 실행시킨다.

---

위에서 환경변수 설정은 github 페이지에 Secrets and variables 탭의 Actions 탭에 들어가보면

 

이렇게 추가를 해줄 수 있다.