잠금 파일로 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. 설명이 달라지는 부분을 코드나 문서의 명시적인 규칙으로 옮긴다.

처음 정한 계약은 영원한 정답이 아니다. 다만 바꾸려면 어떤 사용자가 영향을 받는지 함께 설명할 수 있어야 한다. 오늘의 기준을 짧게 남겨 두면 다음 변경에서 구현 취향과 제품의 약속을 구분하기 쉬워진다.