GitHub Action을 통한 CI 구축하기 (SpringBoot + Maven)

• 안녕하세요~ 이전에 운영하던 블로그 및 GitHub, 공부 내용을 정리하는 Study-GitHub 가 있습니다!

• 네이버 블로그

• GitHub

• Study-GitHub

• 🐔

---

 

📎 GitHub Action을 통한 Build 자동화 (SpringBoot + Maven)

안녕하세요! 이번에 정리할 내용은 GitHub Action을 통해 프로젝트를 자동으로 Build 하도록 설정해보겠습니다.

 

현재 AWS EC2에 Spring Boot 애플리케이션이 실행되고 있는데요, 배포하기까지의 과정은 다음과 같습니다.

• 로컬에서 코드 수정 -> Commit -> GitHub PR -> Merge
• AWS에서 수정된 코드 pull -> 실행중인 애플리케이션 정지(kill) -> 메이븐 빌드 -> 애플리케이션 실행

 

시간이 엄청 잡아먹는 내용은 아니지만, 그래도 한 번 배포할때까지 굉장히 많은 작업이 이루어지게 됩니다.

또한 직접 손으로 작업을 한다면 실수할 여지도 생기고, 배포를 많이하면 할수록 더 많이 시간을 잡아먹겠죠?

 

따라서 이러한 과정을 한 번 시간을 들여 자동화를 진행해놓으면, 이후 반복적인 작업은 할 필요가 없습니다!!

즉, 이와 같은 과정을 CI(Continuous Integration) - 지속적 통합 , CD(Continuous Delivery) - 지속적 전달

이라고 합니다.

 

새로 개발한 기능, 비즈니스 로직 등을 실제 서비스에 반영하기 위해서는 위와 같은 과정인 머지, 테스트, 빌드, 배포 등등의 작업이 필요한데 이러한 작업을 자동화하는 것을 의미합니다.

 

CircleCI, TravisCI, Jenkins 등등 여러 유명한 CI / CD 툴이 존재하는데요, 저는 GitHub Action을 통해 진행해보도록 하겠습니다.

 

GitHub Action은 깃허브에서 공식적으로 제공하는 CI / CD 툴인데 저는 사용해보지 않았고, 깃허브에서 일원화된 개발 환경으로 모든 과정을 관리할 수 있는 편리함이 있기 때문에 GitHub Action을 선택했습니다!

 

(이번 포스팅에서 진행할 내용은 GitHub에 이벤트 발생 시(Push & PR) 자동으로 Build를 진행하는 과정입니다.)

---

 

🎯 GitHub Action yml 파일 생성하기

저는 Spring Boot + Maven + IntelliJ 환경에서 작업을 진행하고 있습니다.

yml 파일은 GitHub의 Actions 탭에서 직접 생성을 할 수 있고, 직접 코드를 작성해도 됩니다.

 

연동할 GitHub 프로젝트에서 Actions 탭으로 들어갑니다.

 

 

Java with Maven 을 선택합니다. (Set up this workflow)

 

 

경로는 보시면 프로젝트 > .github/workflows/yml파일 

항상 위와 같은 구조가 되어야 합니다.

yml 파일은 다음과 같은 구조로 작성되어 있습니다.

 

on: 

• 이벤트를 감지하며 워크플로우를 실행시키는 조건
• 위 파일은 main 브랜치로 push 및 pr(pull_request)의 이벤트가 발생할 때 실행이 됩니다.

 

jobs:

• 하나의 인스턴스에서 여러 Step(컴파일, 테스트, 빌드, 배포 등등)을 그룹화시켜 실행하는 역할으로, 병렬로 실행됩니다.
• runs-on: GitHub Action 스크립트가 작동될 OS 환경을 지정합니다.
• uses: actions/checkout@v2: 프로젝트 코드로 checkout을 합니다.
• uses: actions/setup-java@v2: GitHub Action이 실행될 OS에 Java를 설치합니다.
• steps: 하위 부분은 해당 steps에 대한 속성입니다.

먼저 위와 같이 설정을하고 main 브랜치에 push나 pr이벤트가 발생했을때, 정상적으로 build가 되는지 테스트해봅시다.

 

 

 

 

🎯 GitHub Action을 통해 빌드하기

위 작성이 끝나면 push 혹은 PR을 통해 빌드를 확인해봅니다.

간단한 작업을 진행한 후 main 브랜치로 PR을 요청하면 위와 같이 GitHub Action 이 작동합니다.

 

 

현재 Actions 이 진행중이며, 작업 완료 시 아래와 같은 표시가 나타나게 됩니다.

workflow의 로그를 확인하고 싶으면 해당 build를 클릭합니다.

 

 

그럼 위와 같이 각 job 별로 로그를 확인할 수 있습니다.

 

 

 

 

🎯 GitHub Action에 Time 로그 추가하기

yml 파일에 build 시점의 현재 시간을 출력하는 job을 추가해보도록 하겠습니다.

      - name: Get Current Time
        uses: 1466587594/get-current-time@v2
        id: current-time
        with:
          format: YYYY-MM-DDTHH:mm:ss
          utcOffset: "+09:00" # 기준이 UTC이기 때문에 한국시간인 KST를 맞추기 위해 +9시간 추가

      - name: Print Current Time
        run: echo "Current Time=${{steps.current-time.outputs.formattedTime}}" # current-time 에서 지정한 포맷대로 현재 시간 출력
        shell: bash

위 코드를 yml 파일에 포함한 뒤 전체 코드를 확인하면 다음과 같습니다.

 

 

# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven

name: Oneline-GitHub Action

on: # 이벤트 감지, 워크플로우를 실행시키는 조건 설정
  push:
    branches: [ main ] # push 되면 실행될 브랜치 선택(main)
  pull_request:
    branches: [ main ] # pull_request(PR) 되면 실행될 브랜치 선택(main)

jobs: # job - 하나의 인스턴스에서 여러 Step을 그룹시켜 실행하는 역할, 병렬로 실행
  build:
    runs-on: ubuntu-latest

    steps: # 순차적으로 명령어 수행
      - name: Checkout
        uses: actions/checkout@v2

      - name: Set up JDK 11
        uses: actions/setup-java@v2
        with:
          java-version: '11'
          distribution: 'adopt'

      - name: Build with Maven
        run: mvn -B package --file back/pom.xml

      - name: Get Current Time
        uses: 1466587594/get-current-time@v2
        id: current-time
        with:
          format: YYYY-MM-DDTHH:mm:ss
          utcOffset: "+09:00" # 기준이 UTC이기 때문에 한국시간인 KST를 맞추기 위해 +9시간 추가

      - name: Print Current Time
        run: echo "Current Time=${{steps.current-time.outputs.formattedTime}}" # current-time 에서 지정한 포맷대로 현재 시간 출력
        shell: bash

 

위 과정을 끝낸 후 push를 진행하고 GitHub Action을 확인하면 위와 같이 빌드시점의 시간이 출력되는걸 볼 수 있습니다.

 

 

 

 

🎯 GitHub Action에 cache 적용하기

GitHub Action에서 workflows 시간을 단축시키기 위해 cache를 적용해 봅시다.

자세한 내용은 아래 사이트를 참고해주세요!

https://docs.github.com/en/actions/guides/caching-dependencies-to-speed-up-workflows

 

      # Caching dependencies
      - name: Cache Maven packages
        uses: actions/cache@v2
        with:
          path: ~/.m2
          key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
          restore-keys: ${{ runner.os }}-m2

yml 파일에서 build 바로 위에 위 코드를 추가합니다.

 

위와 같이 적용하고 테스트를 진행해봅니다.

 

 

캐시를 적용하기 전에는 build 시간이 평균 70 ~ 80초정도 걸렸다면,

캐시를 적용한 후에는 평균 50 ~ 60초정도의 시간이 소요됩니다.

결론적으로 20~30% 정도의 시간이 단축되었는데요, 꽤 쏠쏠한 것 같습니다 🐝

 

 

 

 

 

References

• https://jojoldu.tistory.com/543
• https://isntyet.github.io/deploy/github-action%EA%B3%BC-aws-code-deploy%EB%A5%BC-%EC%9D%B4%EC%9A%A9%ED%95%98%EC%97%AC-spring-boot-%EB%B0%B0%ED%8F%AC%ED%95%98%EA%B8%B0(1)/
• https://docs.github.com/en/actions/guides/building-and-testing-java-with-maven
• https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions