[깃허브] Codecov 적용하여 PR에 테스트 커버리 뱃지 달기

https://app.codecov.io/

 

codecov에 로그인해서 깃허브와 연동하면
다음과 같이 레포지토리를 선택할 수 있다.

 

 

(나는 퍼블릭 레포지토리로 진행하여 프라이빗 레포지토리의 경우에는 방식이 다를 수 있다.)

 

원하는 레포지토리를 선택하고
나는 GitHub Actions를 이용해 CI/CD 파이프라인을 구축하기 때문에
셋업 옵션은 GitHub Options를 선택했다.

 

 

아마 codecov를 적용하려는 사람은
스프링에서 jacoco를 이미 적용했을 것이다.
그런 경우 다음 과정은 생략한다.

 

 

토큰을 발급받아 codecov와 내 레포를 연결한다.
깃허브 레포의 Setting > Security > Secrets and variables > Actions에서
똑같이 추가하면 된다.

 

 

 

너무나도 친절하게
workflow 파일에 어떻게 적어야할지 그대로 알려준다.

 

 

.github/workflows/test.yml에 다음과 같이
작성하여 메인 브랜치에 PR이 생성될 때마다
테스트가 실행되고 테스트 커버리지를 확인하도록 설정하였다.

 

name: CI workflow

on:
  pull_request:
    branches:
      - main

jobs:
  # job을 식별하기 위한 id
  My-Test-Job:
    runs-on: ubuntu-latest
    steps:
      - name: Run tests
        run: | # 여러 명령어 문장 작성 가능
          ./gradlew test
      - name: Upload coverage reports to Codecov
        uses: codecov/codecov-action@v5
        with:
          token: ${{ secrets.CODECOV_TOKEN }}

 

이런 설정은 레포지토리의 Action 탭에서 추가한다.
'Java with Gradle'로 했다.

 

다른 브랜치에서 메인으로 PR을 생성하였다.

캡쳐를 놓쳤지만 그럼 해당 액션이 빙글빙글 돌아가며 진행된다.

 

끝나면 다음과 같다.

 

'Upload coverage reports to Codecov' 작업을 보면
무엇이 많이 진행된 것 같은데 가독성이 좋지 않다.

 

 

이때는 codecov 앱을 이용하면 된다.

초기 화면에서 앱을 설치할 수 있다.
나는 원하는 레포지토리에만 설치했다.

 

 

다시 액션으로 돌아오면
작업 하단에 링크가 있다.

 

클릭하면 내 커버리지를 확인할 수 있다.
현재 내 커버리지는 50.55퍼센트이다.

 

 

codecov 앱을 이용하면
PR에 측정 결과를 댓글로 알려준다고 한다.

음 근데 난 이게 첫 PR이라 그런지 안 알려준다.

 

 

이제 뱃지를 달아주자.

codecov 사이트에서 해당 레포지토리의 Configure > Badges & Graphs를 확인한다.

 

 

여기서 마크다운을 복사하여 리드미에 붙여놓으면 된다.

 

 

짜잔~

추가로 달 수 있는 뱃지가 하나 더 있다.

 

해당 워크플로우의 우측에서 ...을 클릭하면
'Create status badge'를 찾을 수 있다.

클릭하면 이러한 화면이 뜨는데

 

얘도 리드미에 붙여놓으면

 

 

이렇게 CI 워크플로우에 대해 테스트 통과와 테스트 커버리지 뱃지를 표시할 수 있다~!

 

 

참고자료

• https://shanepark.tistory.com/457