[CI/CD] 실시간 채팅 애플리케이션 프로젝트 - GitHub Actions를 통한 CI/CD 구축하기 - (2)

📖 목차

 

 

 

---

 

지난 포스팅에서 CI/CD가 무엇인지에 대해 알아보았다.

[CI/CD] 실시간 채팅 애플리케이션 프로젝트 - GitHub Actions를 통한 CI/CD 구축하기 - (1)

 

 

이번 포스팅에서는 프로젝트 초기 세팅과 더불어 GitHub Actions를 활용해 직접 CI/CD를 구축해 보자.

 

 

 

 

 

 

 

📌  GitHub에서 설정하기

  인텔리제이에서 프로젝트를 생성하고, 깃허브 레포지토리에 연결해 주거나 깃허브에서 바로 레포지토리를 생성해도 된다.

<깃허브에서 레포지토리 생성 후>

  깃허브 레포지토리를 생성하면 나오는 페이지에서 Actions 탭을 선택하거나 creating new file을 선택 후 다음 단계로 넘어가준다. Actions 탭을 선택하면 템플릿을 검색하고 선택할 수 있는 페이지로 넘어가고, creating new file을 선택하면 바로 yml파일 편집 페이지로 넘어갈 수 있다.

 

 

 

 

 

<템플릿 선택 페이지>

  이미 지원하고 있는 템플릿들이있기 때문에 검색을 통해 원하는 템플릿을 선택하면 된다. gradle 템플릿을 사용할 것이기 때문에 Java with Gradle을 선택해 준다.

 

 

 

 

 

<yml파일 기본 템플릿>

  이제 원하는 대로 yml파일을 편집해 주면 된다.

 

 

 

 

 

* creating new file을 선택해서 바로 파일 편집 페이지로 넘어온다면, 다음과 같이 파일 경로를 직접 설정해주어야 한다.

/.github/workflows/gradle.yml

 

 

 

 

 

 

 

 

---

 

 

 

 

 

 

 

💡 yml파일을 작성하기 전에, GitHub Actions에 대해 간단히 알아보자.

<GitHub Actions의 구조-1>

<GitHub Actions의 구조-2>

 

 

 

• Workflow
  • 최상위 개념으로 여러 Job으로 구성된다.
  • Event에 의해 트리거 될 수 있는 자동화된 프로세스이다.
    
    
• Event
  • Github Repository에서 발생하는 push, pull request open, issue open, 특정 시간대 반복(cron) 등의 특정한 규칙이다.
  • workflow를 실행(trigger)한다.
    
    
• Runner
  • Github Action Runner app이 설치된 VM
  • Workflow가 실행될 instance로, 각각의 Job 들은 개별적인 runner에서 실행된다.
    
    
• Job
  • 하나의 runner에서 실행될 여러 step의 모음을 의미한다.
    
    
• Step
  • 실행 가능한 하나의 shell script 또는 action을 의미한다.
    
    
• Actions
  • Workflow의 가장 작은 단위로 재사용이 가능하다.
  • Job을 만들기 위해 Step들을 연결한다.

 

 

 

GitHub Actions의 구조에 대해 간단하게 알아보았다.

아래에서 직접 yml파일을 작성해 보자.

 

 

 

 

 

 

 

---

 

 

 

 

 

 

 

 

📌  yml파일 작성하기

  yml파일 예시이다. develop이나 feature로 시작하는 브랜치에 코드가 push 되거나 develop을 destinination으로 하는 pull request가 생성되면 ./gradlew clean test를 실행한다. 

# Actions 이름 github 페이지에서 볼 수 있다.
name: Run Test

# Event Trigger 특정 액션 (Push, Pull_Request)등이 명시한 Branch에서 일어나면 동작을 수행한다.
on: 
    push:
        # 배열로 여러 브랜치를 넣을 수 있다.
        branches: [ develop, feature/* ]
    # github pull request 생성시
    pull_request:
        branches: 
            - develop # -로 여러 브랜치를 명시하는 것도 가능

    # 실제 어떤 작업을 실행할지에 대한 명시
jobs:
  build:
  # 스크립트 실행 환경 (OS)
  # 배열로 선언시 개수 만큼 반복해서 실행한다. ( 예제 : 1번 실행)
    runs-on: [ ubuntu-latest ] 

    # 실제 실행 스크립트
    steps: 
      # uses는 github actions에서 제공하는 플러그인을 실행한다.(git checkout 실행)
      - name: checkout
        uses: actions/checkout@v4

      # with은 plugin 파라미터 이다. (java 17버전 셋업)
      - name: java setup
        uses: actions/setup-java@v2
        with:
          distribution: 'adopt' # See 'Supported distributions' for available options
          java-version: '17'

      - name: make executable gradlew
        run: chmod +x ./gradlew

      # run은 사용자 지정 스크립트를 실행한다.
      - name: run unittest
        run: |
          ./gradlew clean test

 

* name: github actions의 이름을 정하는 부분
* on: action이 언제 실행되는지에 대한 부분
* jobs: 실제 실행할 내용에 대한 부분
* runs-on: 어떤 환경에서 실행하는지 기술
* steps: 실제 실행할 단계들을 기술
* name: 실행에 표시될 이름
* uses: 여러 가지 plugin과 action을 사용

 

 

 

 

  직접 프로젝트를 진행하면서 작성한 yml파일이다. Spring Boot 기반의 실시간 채팅 애플리케이션을 빌드하고, Docker 이미지를 생성하여 AWS EC2를 활용해 배포하는 CI/CD 파이프라인을 정의한 것이다. 주요 흐름은 이렇다.

name: CI/CD

# main 브랜치에 push 또는 pull_request 발생 시 실행
on:
  push: 
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

# deploy job 실행: ubuntu-latest 환경에서 실행
# contents: read 권한을 사용하여 리포지토리 내용을 읽을 수 있다.
jobs:
  deploy:
    runs-on: ubuntu-latest
    permissions:
      contents: read

# actions/checkout@v3를 사용하여 현재 리포지토리의 코드를 가져온다.
    steps:
      - name: Checkout
        uses: actions/checkout@v3

# actions/setup-java@v3를 이용해 Java 17 환경 설정
      - name: Set up JDK 17
        uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'adopt'

# chmod +x ./gradlew를 실행하여 Gradle Wrapper(gradlew) 실행 권한을 부여
      - name: Give execute permission to gradlew
        run: chmod +x ./gradlew

# ./gradlew bootJar 명령어를 실행하여 Spring Boot 애플리케이션을 빌드
      - name: Build with Gradle Wrapper
        run: ./gradlew bootJar
    
# docker build를 실행하여 Docker 이미지를 생성
      - name: Build Docker Image
        run: |
          echo "${{ secrets.DOCKER_PASSWORD }}" | docker login -u ${{ secrets.DOCKER_USERNAME }} --password-stdin
          docker build -t ${{ secrets.DOCKER_USERNAME }}/chat-app:latest .
          docker push ${{ secrets.DOCKER_USERNAME }}/chat-app:latest

# AWS 서버에 배포
      - name: Deploy to AWS
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.AWS_HOST }}
          username: ubuntu
          key: ${{ secrets.AWS_KEYPAIR }}
          script: |
            sudo docker pull ${{ secrets.DOCKER_USERNAME }}/chat-app:latest
            sudo docker run -d --name chat-app -p 8080:8080 ${{ secrets.DOCKER_USERNAME }}/chat-app:latest
            sudo docker image prune -f

 

 

 

 

 

 

 

📌  환경변수 설정하기

  계정 정보와 같이 노출되어서는 안 되는 민감한 정보를 환경변수로 설정하여 사용할 수 있다. 

Settings 탭에서 Secrets and variables-actions를 선택하면 다음과 같은 페이지로 이동한다. New repository secret를 선택하면 아래와 같이 새로 생성할 수 있다. 생성 뒤에도 수정이나 삭제를 통해 환경변수들을 관리할 수 있다.

<환경변수 설정하기-1>

 

 

 

 

  

<환경변수 설정하기-2>

 

 

 

 

 

<환경변수 설정하기-3>

 

 

 

 

 

 

 

📌  CI/CD 결과 확인하기

  환경변수까지 전부 세팅되었다면, main 브랜치로 push 되었을 때 해당 스크립트가 실행되게 된다. 순차적으로 워크플로우가 진행되고 결과는 Actions 탭에서 확인이 가능하다.

<CI/CD 결과 확인하기-1>

 

 

  실패한 내역도 확인할 수 있고, 당연히 왜 실패했는지도 상세하게 확인이 가능하다.

<CI/CD 결과 확인하기-2>

 

 

 

  화살표를 눌러보면 실패한 부분의 에러 메시지를 확인할 수 있다. 필자 같은 경우에는 Docker 이미지를 빌드할 때 에러가 발생했다.

DockerFile에서 jdk 이미지를 수정하고, 계정 로그인 관련된 부분은 Docker에서 token을 발급하고 설정하여 해결했다.

최종적으로는 성공한 것을 위의 이미지에서 확인할 수 있다.

<CI/CD 결과 확인하기-3>

 

 

 

 

 

 

 

---

 

 

 

 

 

 

 

💡 여기까지 GitHub Actions를 통해 CI/CD 파이프라인을 구축하는 방법에 대해 알아보았다.

 

이번 실시간 채팅 애플리케이션 프로젝트를 진행하면서 처음 CI/CD를 경험해 보아서 그런지

간단한 내용이었지만 시간이 조금 걸렸던 것 같다.

 

처음 접해보는 내용이라 최대한 자세하게 포스팅해 두었으니

다음번에 CI/CD 파이프라인을 구축할 일이 생기면 조금은 더 빨리 진행할 수 있지 않을까 싶다.

* 포스팅이 길어져서 AWS EC2 배포 과정은 참고 링크를 올려두었다. 

 

다음 포스팅에서도 실시간 채팅 애플리케이션 프로젝트에 관한 내용을 다룰 예정이다.

 

 

 

 

 

 

 

 

 

📌  참고

SpringBoot 프로젝트 EC2 배포하기

 

 

[CI/CD] Github Action을 활용한 SpringBoot CI/CD 구축

 

 

[CICD] GitHub Action으로 CI/CD 구축하기

 

 

Docker와 GitHub Actions