3.4 KiB
3.4 KiB
🏷️ Git 운영 및 통합 업데이트 관리 규칙
이 문서는 Smart IMS 플랫폼의 Git 운영 정책, 태그 작성 규칙, 그리고 운영 서버 수동 업데이트 방법을 설명합니다.
1. 태그 메시지 작성 규칙 (Changelog 자동 생성)
플랫폼의 업데이트 엔진은 태그 메시지의 **머리말(Prefix)**과 **리스트 기호(-, *)**를 분석하여 관리 페이지의 업데이트 히스토리를 생성합니다.
📋 메시지 구조
[TYPE] 업데이트 제목 (한 줄 요약)
- 상세 변경 내용 1
- 상세 변경 내용 2
* 상세 변경 내용 3
🏷️ 업데이트 타입 (TYPE) 정의
| 키워드 | 업데이트 유형 | 시각적 표시 | 비고 |
|---|---|---|---|
[URGENT] |
긴급/보안 | 빨간색 배너 | 최우선 업데이트 권장 |
[HOTFIX] |
긴급 수정 | 빨간색 배너 | 버그 즉시 수정 건 |
[FEATURE] |
기능 추가 | 남색(Indigo) | 새로운 기능 도입 |
[FIX] |
일반 수정 | 회색(Slate) | 일반적인 버그 수정 |
[PATCH] |
패치/보정 | 회색(Slate) | 마이너 품질 개선 |
2. 개발 및 배포 절차 (개발 PC)
모든 명령어는 프로젝트의 최상위 루트 폴더(smart_ims/)에서 실행합니다.
STEP 1: 코드 변경 사항 커밋 및 푸시
# [위치: 프로젝트 루트]
git add .
git commit -m "릴리즈 준비: v0.3.5 패치"
git push origin main
STEP 2: 어노테이티드 태그(Annotated Tag) 생성
# [위치: 프로젝트 루트]
git tag -a v0.3.5 -m "[PATCH] 시스템 안정화 패치
- 원격 태그 동기화 로직 강화
- API 캐시 방지 타임스탬프 도입"
STEP 3: 원격 저장소에 태그 푸시
# [위치: 프로젝트 루트]
git push origin v0.3.5
3. 운영 서버 수동 업데이트 방법 (Manual Update)
웹 UI 업데이트가 실패하거나 서버에서 직접 제어해야 할 경우 사용합니다.
STEP 1: 원격 정보 동기화 및 체크아웃
# [위치: 프로젝트 루트]
# 1. 태그 정보 강제 업데이트
git fetch origin +refs/tags/*:refs/tags/* --force --prune --prune-tags
# 2. 대상 버전으로 강제 체크아웃
git checkout -f v0.3.5
STEP 2: 프론트엔드 빌드
# [위치: 프로젝트 루트]
npm install
npm run build
STEP 3: 백엔드 반영 및 서비스 재시작
# [위치: 서버 폴더 (프로젝트루트/server)]
cd server
npm install
pm2 reload smartims-api
4. 유용한 Git 명령어 레퍼런스
- 태그 목록 확인:
git tag -l(루트 실행) - 최신 태그 정보 확인:
git describe --tags --abbrev=0(루트 실행) - 원격 태그 강제 덮어쓰기 (수정 시):
# [위치: 프로젝트 루트] git tag -a v0.3.5 -f -m "수정된 메시지..." git push origin v0.3.5 -f
💡 주의사항
- 실행 위치 확인: 특히
pm2명령어나server관련 설정은 반드시server폴더 내에서 실행하거나 경로를 정확히 지정해야 합니다. - 경로 이동:
cd server를 통해 폴더를 이동한 후 작업을 마쳤다면, 다시cd ..를 통해 루트로 복귀하는 습관이 중요합니다. - 권한: 운영 서버에서는 가급적 서비스 소유 계정으로 명령어를 실행하세요.