잠금 파일로 CI 의존성 설치 고정하기, 실패를 설명할 단서 남기기

로컬에서는 통과한 코드가 CI에서 다른 의존성 버전을 받으면 문제 원인이 코드인지 환경인지 구분하기 어렵다. 설치 과정도 검증의 입력으로 취급한다.

실패했다는 사실만으로는 다음 행동을 정하기 어렵다. 어떤 입력으로 어디까지 진행했으며 무엇을 기대했는지가 함께 있어야 한다. 이번에는 성공 여부를 표시하는 데서 한 걸음 더 나아가, 다음 사람이 같은 조건을 확인할 수 있도록 관찰 항목을 정리한다.

결과와 원인을 구분하는 기록

매니페스트와 잠금 파일을 함께 변경하고 CI에서는 잠금 파일 수정을 허용하지 않는 설치를 사용한다. 런타임 버전도 프로젝트에 명시한다.

이번에 확인할 질문: 결과만 전달받은 사람이 원래 입력과 기대 동작을 복원할 수 있는가?

작게 확인하는 예제

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

npm ci
# With other package managers, use their frozen-lockfile mode.
# Commit the manifest and lockfile together.

잠금 파일과 매니페스트를 일부러 어긋나게 했을 때 CI 설치가 실패하는지 확인한다.

놓치기 쉬운 조건

잠금 파일이 있어도 운영체제나 런타임 차이에 영향을 받는 패키지가 있다. 캐시는 설치 검증을 생략하는 근거가 아니라 다운로드를 줄이는 수단이다.

확인할 부분	살펴볼 내용
기준 동작	잠금 파일과 매니페스트를 일부러 어긋나게 했을 때 CI 설치가 실패하는지 확인한다.
비교 조건	입력과 실행 순서를 고정하고 한 번에 한 조건만 바꾼다.
적용 범위	예제가 생략한 의존성과 실제 서비스의 제약을 구분한다.

다음 변경에 적용할 순서

1. 기대 결과와 실제 결과를 서로 다른 칸에 적는다.
2. 개인정보나 비밀값을 제외하고 재현에 필요한 조건만 남긴다.
3. 관찰 사실과 원인에 대한 가설을 구분해 후속 확인을 정한다.

기록을 많이 남기는 것과 유용하게 남기는 것은 다르다. 원인을 좁히는 데 쓰이지 않는 항목은 줄이고, 누락 때문에 다시 묻게 되는 조건은 보완한다. 관찰할 수 있는 범위가 분명해지면 실패한 상황에서도 다음 실험을 작게 잡을 수 있다.