GitHub Repository에 Coveralls 배지 적용하기

시작

Java와 Spring을 사용하는 프로젝트에서 GitHub Actions로 CI/CD를 구성할 때 Coveralls 배지를 적용하는 방법을 공유하고자 합니다.

본문

Coveralls에 회원가입하고 리포지토리를 연동하는 과정은 생략하겠습니다. 자세한 내용은 Coveralls 가이드를 참조하세요.

1. Jacoco 설정

build.gradle 파일에 다음 코드를 추가하여 Jacoco를 설정합니다

plugins {
    ...
    id 'jacoco'
}

tasks.named('test') {  
    ...
    finalizedBy jacocoTestReport  
}

jacocoTestReport {  
    reports {  
        xml.required = true  
    }  
}

이 설정은 테스트 시 Jacoco로 커버리지 XML 형식의 리포트를 생성하도록 합니다.

2. GitHub Actions 설정

GitHub Actions 워크플로우 파일에 다음 단계를 추가합니다

jobs:  
  ci:  
    runs-on: ubuntu-latest  
    steps:  
      - name: 레포지토리를 체크아웃한다  
        uses: actions/checkout@v4  
      - name: 자바를 설치한다  
        uses: actions/setup-java@v4  
        with:  
          distribution: 'corretto'  
          java-version: '17'  
      - name: 어플리케이션을 빌드한다  
        run: |  
          chmod +x gradlew  
          ./gradlew build  
      - name: CoverAlls를 실행한다  
        uses: coverallsapp/github-action@v2  
        with:  
          base-path: build/reports/jacoco/test/jacocoTestReport.xml

이 단계는 프로젝트를 실행한 후 coverallsapp/github-action을 사용하여 Jacoco 리포트를 Coveralls로 전송합니다.

3. 배지 복사

CI/CD가 실행되면 Coveralls에서 특정 브랜치의 커버리지 수치를 업데이트합니다. Coveralls 사이트에서 배지를 복사하여 프로젝트의 README 파일에 붙여넣을 수 있습니다.

마무리

간단하게 GitHub 리포지토리에 Coveralls 배지를 적용하는 방법을 설명했습니다. 이제 리포지토리에 Coveralls 배지를 추가하여 프로젝트의 테스트 커버리지를 자랑할 수 있습니다.