배포 리뷰 체크리스트

전 회사를 다닐 때 AWS SA 출신의 기술부장님이 계셨다. ☁️

그때 여러가지 선진문물을 배워볼 수 있었는데, 당시에는 프론트엔드 개발자였던 나에게 굉장히 생소한 것 중 하나가 바로 배포 리뷰였다.

당시에는 굉장히 낯설고 백엔드 위주의 내용들이었는데, 현재 새롭게 백엔드 일을 하게되면서 다시금 그 중요성을 깨닫고 나만의 체크리스트를 정리해본다.

이런 체크리스트와 배포 리뷰를 한다면 운영 배포 시 발생할 수 있는 영향도를 최소화할 수 있고 무엇보다도 시스템적으로 개발자들이 안전하다는 자신감과 공동책임(Shared Responsibilty), 올바른 사후부검과 대책, 런북과 리뷰 시스템 강화를 꾀할 수 있다.

기존 변경사항 체크리스트

1. 기존 환경변수가 변경되었는가?

   • ConfigMap, env 파일, 파라미터 스토어 등

2. 기존 서드파티 시스템의 연동사항이 변경되었는가?

   • 외부 API, DB, 결제나 인증 관련 등

3. 기존 api 엔드포인트 명세가 변경되었는가?

   • 스웨거 문서 수정, api 버저닝

4. 기존 스키마에 변경사항이 있는가?

   • 마이그레이션, 데이터 수정 계획이 뒷따른다.

신규 변경사항

1. 새롭게 추가된 환경변수가 있는가?

2. 새롭게 추가된 서드파티 시스템이 있는가?

3. 새롭게 추가된 패키지나 라이브러리가 있는가?

   • 현재 사용하는 베이스 이미지와의 충돌은 없는지

4. 새롭게 추가된 api 엔드포인트가 있는가?

   • 스웨거 문서 업데이트

안정성

1. DB 데이터 변경이 필요한가?

   • 배포 이후나 이전에 수행되어야한다면 수행 계획과 스크립트 준비

2. 인프라 변경사항이 있는가?

   • 큰 변경사항이기에 유사한 환경에서 테스트 필요

3. 마스터 빌드에 이상은 없는가?

   • 빌드 로그 확인

4. 배포 후 기능변경 및 개선을 모니터링할 수 있는 장치가 있는가?

   • 기능 배포 이후 운영을 생각한다면 모니터링 방법까지 준비한다

5. 누락된 커밋은 없는가?

   • 배포 시 커밋 리스트 확인 및 코드 리뷰