Project

General

Profile

Feature #1264

Updated by 성용 양 14 days ago

## 목적 

 PR마다 자동으로 테스트와 검사를 돌려 서로 다른 사람의 변경이 합쳐질 때 깨지는 것을 일찍 발견합니다. 

 ## 쉬운 설명 

 코드를 올릴 때마다 자동으로 테스트·코드 검사·마이그레이션 검사를 돌리는 GitHub Actions 설정입니다. 

 ## 기술 스택 

 GitHub Actions, PostgreSQL 서비스 컨테이너, ruff, pytest, `makemigrations --check`. 

 ## 예상 결과(산출물) 

 .github/workflows/ci.yml, 실패 시 병합 차단 규칙, 실행 시간 기록. 

 ## 개발 작업 상세 

 1. 워크플로를 만든다: 의존성 설치, ruff, Django `check`, PostgreSQL 테스트 DB, pytest, `makemigrations --check --dry-run`(migration drift). 
 2. 운영 데이터·실제 비밀키는 CI에 넣지 않는다(합성 데이터와 테스트용 키만). 
 3. 브랜치 보호 규칙에서 CI 통과를 병합 조건으로 설정한다(저장소 관리자 권한 필요). 
 4. GitHub Actions 무료 사용량·예산 한도를 확인한다(가이드 10절). 

 ## 완료 기준 

 - PR에서 CI가 자동 실행된다. 
 - CI가 실패하면 병합할 수 없다. 

 ## 충돌 방지(소유 범위) 

 .github/는 성용 소유. 01-03에서 우섭이 만든 PR 템플릿과 같은 폴더이므로 파일을 분리(workflows/ 하위만 이 일감에서 수정)합니다. 

 ## 선행·후행·위험 

 선행: 01-01 저장소·Django 골격·앱 스텁·설정 분리(우섭, 11/06 종료) 

 후행: 04-04 승인형 CD·마이그레이션 게이트·배포 점검(성용) 

 위험: 무료 사용량 초과. 

 ## 결과 확인 방법 

 "완료 기준"의 각 항목을 화면 또는 명령으로 직접 확인합니다. 

 1. PR에서 CI가 PR을 올리면 Actions가 자동 실행된다. 
 2. CI가 실패하면 병합할 수 없다. 
 3. 확인 결과(화면 캡처 또는 명령 출력 요약)를 일감 메모에 남긴다. 실행되고, 일부러 틀린 코드를 올리면 실패 표시가 나는지 확인하면 완료입니다. 

 ## 시작 전 준비 

 1. 00-01·00-03 결정 내용과 팀 비밀 저장소(접속 정보 보관 위치)를 확인한다. 
 2. 개발 가이드 7~9절을 읽는다. 
 3. 서버 비밀번호·키·토큰은 일감, 저장소, 채팅에 적지 않는다. 

 ## 작업 진행 순서 

 1. "개발 작업 상세"를 순서대로 진행하며 각 단계의 명령과 결과를 기록한다. 
 2. 한 단계가 끝날 때마다 "완료 기준"의 확인 항목을 점검한다. 
 3. 설정 파일은 저장소에 올리고, 비밀 값은 비밀 저장소(GitHub Secrets 등)에만 둔다. 
 4. PR로 올려 소유자 리뷰를 받고, 서버 작업 내용은 일감 메모에 남긴다. 

 ## 막힐 때 확인 

 Actions가 실패하면 로그의 첫 번째 빨간 줄을 먼저 보세요. 로컬에서 같은 명령을 실행하면 대부분 재현됩니다. 

 그래도 해결되지 않으면 일감 메모에 "무엇을 했고, 어떤 오류가 났는지"를 붙여 담당 분류 소유자 또는 팀장에게 질문하세요. 

 ## 용어 풀이 

 - **마이그레이션**: 모델(코드)의 변경을 DB 구조에 반영하는 변경 기록 파일과 그 적용 작업입니다. makemigrations로 만들고 migrate로 적용합니다. 
 - **CI(지속적 통합)**: 코드를 올릴 때마다 자동으로 테스트·검사를 돌리는 장치입니다. 여기서는 GitHub Actions를 씁니다. 
 - **pytest**: Python 코드를 자동으로 검사해 주는 테스트 도구입니다. 테스트 파일은 tests/ 폴더에 둡니다. 
 - **PR(풀 리퀘스트)**: 내 브랜치의 변경을 main에 합쳐 달라고 요청하고 리뷰를 받는 절차입니다. 
 - **합성 데이터**: 실제 개인정보가 아닌, 시험용으로 만든 가짜 데이터입니다. 
 - **Django 템플릿**: HTML에 데이터가 들어갈 자리를 표시해 둔 화면 틀입니다. 기본(base) 템플릿을 상속해 공통 메뉴를 재사용합니다.

Back