Git bisect로 회귀가 들어온 범위 좁히기, 유지보수할 때 남겨 둘 예제

과거에는 되던 동작이 언제 깨졌는지 모를 때 모든 커밋을 순서대로 읽는 것은 비효율적이다. 명확한 재현 명령이 있으면 변경 범위를 이분 탐색할 수 있다.

시간이 지나면 왜 이렇게 구현했는지보다 어떻게 실행하는지만 남기기 쉽다. 옵션과 제약을 잊은 채 코드를 정리하면 의도했던 동작까지 바뀔 수 있다. 이번에는 작은 예제를 실행 가능한 설명으로 남기고, 구현이 달라져도 유지할 부분을 분리한다.

다시 읽을 수 있는 최소 맥락

좋은 기준 커밋과 나쁜 기준 커밋을 지정하고 동일한 재현 조건으로 중간 커밋을 판정한다. 작업 전 변경을 보존하고 별도 작업 사본을 사용한다.

이번에 확인할 질문: 내부 구조를 바꾸더라도 이 예제가 설명하는 결과는 그대로 유지되어야 하는가?

작게 확인하는 예제

다음 예제는 핵심 조건을 드러내기 위한 출발점이다. 서비스의 전체 구현을 대신하지 않으므로 실제 입력 범위와 실패 처리 규칙을 함께 읽어야 한다.

git bisect start
git bisect bad <failing-revision>
git bisect good <working-revision>
git bisect run ./scripts/reproduce.sh
git bisect reset

찾은 커밋의 직전과 직후에서 같은 재현 명령을 다시 실행해 차이가 일관적인지 확인한다.

놓치기 쉬운 조건

재현 스크립트는 성공과 실패의 종료 코드를 정확히 구분해야 한다. 환경 변화나 간헐적 실패가 원인이면 커밋 탐색 결과를 곧바로 확정할 수 없다.

확인할 부분	살펴볼 내용
기준 동작	찾은 커밋의 직전과 직후에서 같은 재현 명령을 다시 실행해 차이가 일관적인지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 구현 세부 사항보다 외부에서 관찰하는 결과를 적는다.
2. 예제가 의존하는 입력과 환경을 가까이에 둔다.
3. 설명이 실제 동작과 달라지면 코드와 예제를 같은 변경에서 고친다.

오래 남는 문서는 가장 긴 문서가 아니라 다시 확인할 수 있는 문서다. 선택의 이유와 작동하는 예제가 함께 있으면 새로운 구현으로 옮길 때도 기준을 잃지 않는다. 중복 설명을 늘리기보다 정본이 어디인지 분명히 하는 편이 유지 비용을 줄인다.