[20] Spring CI/CD (2) CI 실전편

지난 번에 개념을 공부했으니 오늘은 Github을 이용하여 CI를 구현하는 방법을 포스팅 : ) 미래의 나를 위한 포스팅이다.

 

 

1. Actions -> new workflow -> Java with Gradle [configure] 클릭

 

2. <>Edit new file 에 코드 추가 -> Start commit

 

Test용으로 생성한 파일 

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle

name: Java CI with Gradle

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]

permissions:
  contents: read

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v3
    - name: Set up JDK 11
      uses: actions/setup-java@v3
      with:
        java-version: '11'
        distribution: 'temurin'
    - name: Grant execute permission for gradlew       // 이부분은 추가로 작성해줘야 한다
      run: chmod +x ./gradlew            			   // Build전에  gradlew 권한을 부여하는 워크플로우
# Build     
    - name: Build with Gradle
      uses: gradle/gradle-build-action@67421db6bd0bf253fb4bd25b31ebb98943c375e1
      with:
        arguments: build

 

아래는 우리 프로젝트에 맞게 커스텀되어있는 코드

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle

name: Java CI with Gradle

on:
  pull_request:
    branches: [ "dev" ]

env:
  AWS_REGION: ap-northeast-2
  S3_BUCKET_NAME: my-cicd-s3-bucket
  CODE_DEPLOY_APPLICATION_NAME: my-codedeploy-app
  CODE_DEPLOY_DEPLOYMENT_GROUP_NAME: my-codedeploy-deployment-group

permissions:
  contents: read

jobs:
  deploy:
    name: Deploy
    runs-on: ubuntu-latest
    environment: production

    steps:
      # 기본 체크아웃
      - name: Checkout
        uses: actions/checkout@v3

      # JDK 11 세팅
      - name: Set up JDK 11
        uses: actions/setup-java@v3
        with:
          java-version: '11'
          distribution: 'temurin'

      # 키 정보 있는 properties 따로 관리
      - name: make application.properties
        if: true
        run: |
          cd ./src/main/resources
          touch ./application.properties
          echo "${{ secrets.PROPERTIES }}" > ./application.properties
        shell: bash

      # gradlew 권한 설정
      - name: Grant execute permission for gradlew
        run: chmod +x ./gradlew
        shell: bash

      # build
      - name: Build with Gradle
        run: ./gradlew clean build -x test
        shell: bash

      # aws 인증
      - name: Configure AWS credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: ap-northeast-2

      # 압축파일 형태로 전달
      - name: Make zip file
        run: zip -qq -r ./$GITHUB_SHA.zip .
        shell: bash

      # S3 bucket으로 copy
      - name: Upload to AWS S3
        run: aws s3 cp --region ap-northeast-2 ./$GITHUB_SHA.zip s3://$S3_BUCKET_NAME/$GITHUB_SHA.zip

      # S3 bucket에 있는 파일을 대상으로 CodeDeploy 실행
      - name: Deploy to AWS EC2 from S3
        run: aws deploy create-deployment --application-name $CODE_DEPLOY_APPLICATION_NAME --deployment-config-name CodeDeployDefault.AllAtOnce --deployment-group-name $CODE_DEPLOY_DEPLOYMENT_GROUP_NAME --s3-location bucket=$S3_BUCKET_NAME,key=$GITHUB_SHA.zip,bundleType=zip

 

3. 나는 이미 CI/CD 적용을 모두 마친상태이기 때문에 위의 코드를 저장하고 테스트용으로 브랜치를 만들어서 main 브랜치에 merge를 해주면 아래와 같이 "This branch is being deployed" 라는 문구를 볼 수 있다.

 

아직 CD 적용을 안 한 상태라면 아래와 같이 "Some checks haven't completed yet" 이라는 checking 문구를 볼 수 있다.

https://littlezero48.tistory.com/289

 

 

4. 다시 Actions 탭을 가보면 아래와 같이 진행 상황을 확인 할 수 있다. 다시 말하지만, 나는 이미 CD를 끝낸 상태로 포스트를 작성했기 때문에 상단에 "Deploy"라고 뜨지만, CI 까지만 진행한 경우 상단에 "build"라는 표시와 함께 아래와 비슷한 화면이 보인다 !

 

이로써 CI는 끝났다! 아주 간단함 ! 

 

---

[ 참고 자료 ]

 

https://littlezero48.tistory.com/289

CI/CD] Github Actions CI

 

소영님 감사합니다 !! ㅎㅎ 소영님 블로그 없으면 아무것도 못할 1인 = 나