Feature #1266
Updated by 성용 양 14 days ago
## 목적
운영 배포는 승인 후에만, 마이그레이션은 별도 승인 게이트로 수행합니다. (가이드 10절 CD)
## 쉬운 설명
승인 버튼을 눌러야만 서버에 배포되는 흐름과, 마이그레이션(DB 구조 변경)을 먼저 확인하는 관문을 만듭니다.
## 기술 스택
GitHub Actions `workflow_dispatch`, `production` 환경 승인 규칙, SSH 배포 키(읽기 전용 Deploy Key), 배포 후 smoke test.
## 예상 결과(산출물)
.github/workflows/deploy.yml, 배포·롤백 절차 문서, smoke test 스크립트.
## 개발 작업 상세
1. 수동 트리거와 production 환경 승인을 적용한 deploy.yml을 만든다.
2. 배포 commit SHA를 고정하고 CI 통과를 확인한 뒤에만 실행되게 한다.
3. 서버 접근 키·호스트키를 검증하고 비밀값이 로그에 출력되지 않게 한다.
4. migration은 자동 실행하지 않고 별도 승인 단계로 분리한다. 실행 전 DB 백업을 확인한다.
5. 배포 후 HTTPS·로그인 차단·핵심 화면 smoke test와 롤백 절차를 문서화한다.
## 완료 기준
- 승인 없이 운영 배포가 실행되지 않는다.
- 롤백 절차가 문서화되었다.
## 충돌 방지(소유 범위)
.github/workflows/deploy.yml과 deploy/는 성용 서현 소유.
## 선행·후행·위험
선행: 04-02 GitHub Actions CI(테스트·린트·마이그레이션 검사)(성용, 11/18 종료) / 04-03 Dockerfile·Compose·/health/·Gunicorn·Nginx 연결·운영 설정(성용, 11/25 종료)
04-02, 04-03. 후행: 04-06 운영 매뉴얼·장애 대응표·배포 인수(성용) / 15-04 인수 체크리스트·운영 인계(최종)(우섭)
## 결과 확인 방법
승인 없이는 배포가 시작되지 않고, 승인 후 배포가 끝나면 /health/와 주요 화면 점검 결과가 남으면 완료입니다.
## 시작 전 준비
1. 00-01·00-03 결정 내용과 팀 비밀 저장소(접속 정보 보관 위치)를 확인한다.
2. 개발 가이드 7~9절을 읽는다.
3. 서버 비밀번호·키·토큰은 일감, 저장소, 채팅에 적지 않는다.
## 작업 진행 순서
1. "개발 작업 상세"를 순서대로 진행하며 각 단계의 명령과 결과를 기록한다.
2. 한 단계가 끝날 때마다 "완료 기준"의 확인 항목을 점검한다.
3. 설정 파일은 저장소에 올리고, 비밀 값은 비밀 저장소(GitHub Secrets 등)에만 둔다.
4. PR로 올려 소유자 리뷰를 받고, 서버 작업 내용은 일감 메모에 남긴다.
## 막힐 때 확인
서버 접속 키는 GitHub Secrets에만 저장하세요. 배포 실패 시 이전 버전으로 되돌리는 방법을 문서에 적어 두세요.
그래도 해결되지 않으면 일감 메모에 "무엇을 했고, 어떤 오류가 났는지"를 붙여 담당 분류 소유자 또는 팀장에게 질문하세요.
## 용어 풀이
- **마이그레이션**: 모델(코드)의 변경을 DB 구조에 반영하는 변경 기록 파일과 그 적용 작업입니다. makemigrations로 만들고 migrate로 적용합니다.
- **CI(지속적 통합)**: 코드를 올릴 때마다 자동으로 테스트·검사를 돌리는 장치입니다. 여기서는 GitHub Actions를 씁니다.
- **CD(자동 배포)**: 검증된 코드를 서버에 자동으로 반영하는 장치입니다. 이 프로젝트는 사람이 승인해야 배포되게 합니다.
- **HTTPS**: 주소창의 자물쇠 표시입니다. 통신 내용을 암호화합니다.
- **SSH**: 원격 서버에 안전하게 접속해 명령을 입력하는 방법입니다. 15-04.
Back