로컬에서는 돌아가지만, git CI 에서는 돌아가지 않는 문제

[nayonsoso]

🔸 배경

• 같은 develop 브랜치에서, 아루는 "Session을 ReviewGroup으로 바꾸는 기능"을,
  나는 "내가 받은 리뷰를 순서대로 정렬하는 기능"을 구현했다.
• 아루가 먼저 머지를 하고, 이후 내가 PR 을 올렸다.
• 이때 내 PR 과 develop 브랜치는 conflit 가 나지 않아서 바로 머지를 해도 된다 생각했다.
• 분명 내 로컬에서는 모든 테스트가 통과되었고, ./gradlew build 도 성공했었다.
• 하지만 git ci 에서는 아래 예외가 나면서 테스트가 실패하였다.

/home/runner/work/2024-review-me/2024-review-
me/backend/src/test/java/reviewme/review/service/ReviewGatheredLookupServiceTest.java:420: 
error: incompatible types: String cannot be converted to ReviewGroup

---

🔸 pull_request로 트리거된 git workflow 의 동작 원리

Note that GITHUB_SHA for this event is the last merge commit of the pull request merge branch. If you want to get the commit ID for the last commit to the head branch of the pull request, use github.event.pull_request.head.sha instead.

ref. https://docs.github.com/ko/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#pull_request

• ❗️pull_request 로 트리거된다면, 이때의 GITHUB_SHA는 PR 머지 브랜치의 머지 커밋이다.❗️
• 이때, "PR 머지 브랜치"란, GitHub가 풀 리퀘스트를 테스트할 때 자동으로 생성하는 가상 브랜치로,
  PR을 develop 에 병합한 결과를 미리 만들어주는 브랜치이다.
• 따라서 pull_request 로 트리거되는 workflow는 PR 을 머지한 값을 기준으로 실행을 하게 된다.

---

🔸 문제 발생 원인

• 내 PR 과 develop 브랜치는 충돌은 나지 않았지만, 머지하면 결과적으로 컴파일 에러가 생기는 상태였다.
• git workflow 는 머지된 상태를 검사하므로, 테스트가 통과하지 않았던 것이다.

---

🔸 재발 방지

• 머지를 해도 되느냐의 기준이 "conflict" 이 아니라는 것을 알게 되었다.
• conflict 이 나지 않더라도 병합했을 때 문제가 발생하는 상황이 있을 수 있다.
• 이를 방지하기 위해서는 병합하려는 브랜치를 rebase 해서
  기존 브랜치에 내가 변경한 것만이 추가되었음을 확실하게 하는 방법이 있을 것 같다.
• CI 가 없었으면 정말 큰일날뻔 했다... 😅