Changeish: AI로 자동화된 변경사항 기록 도구

카테고리

프로그래밍/소프트웨어 개발

서브카테고리

개발 툴

대상자

- 소프트웨어 개발자 및 프로젝트 관리자

- Git을 사용하는 개발자, 로컬 AI 모델(Ollama)을 활용하는 팀

- 자동화와 문서화 프로세스를 개선하고자 하는 개발자

- 난이도: 중간 (Git과 Bash 기본 지식 필요)

핵심 요약

• 시간 절약: 수작업으로 변경사항 기록 대신 LLM(Ollama 기반)이 자동 생성
• 일관성 보장: Markdown 형식으로 변경사항을 강제적 형식(예: 과거형, 명령형) 적용
• 로컬 보안: Ollama를 통해 로컬 AI 모델 사용으로 데이터 누출 방지

섹션별 세부 요약

1. Changeish의 핵심 기능

• Git 히스토리 수집: git 명령어로 최근 커밋 메시지와 차이 분석
• LLM 프롬프트 준비: changelog_prompt.md 템플릿을 통해 AI 모델에 작업 지시
• LLM 기반 생성: Ollama CLI 또는 OpenAI API로 AI 생성된 변경사항 기록 생성
• CHANGELOG.md 자동 업데이트: 생성된 내용을 CHANGELOG.md 상단에 추가

2. 설치 및 사용 방법

• GitHub에서 설치:

- curl 명령어로 changes.sh 및 changelog_prompt.md 다운로드

- chmod +x changes.sh로 실행 권한 부여

• 사용 흐름:

1. 프로젝트 디렉토리로 이동
2. ./changes.sh 실행 → Git 히스토리 수집 및 LLM 생성
3. 생성된 변경사항을 CHANGELOG.md에 자동 추가

3. Ollama 미설치 시 대체 방안

• Prompt 파일 생성: Ollama 없이도 changelog_prompt.md 파일 생성
• 대체 AI 도구 사용: 생성된 프롬프트를 ChatGPT 등 다른 AI 인터페이스로 입력

4. 실무 적용 사례

• 대규모 병합 작업: 여러 Pull Request 병합 후 changeish 실행 → 변경사항 빠른 요약
• 릴리스 준비: 릴리스 전 "Unreleased" 섹션 생성 → 릴리스 노트 초안 제공
• CI/CD 통합: CI 환경에서 changeish를 활용한 자동화된 변경사항 기록

결론

• Changeish는 로컬 AI(Ollama)를 활용해 변경사항 기록 자동화를 가능하게 하며, 시간 절약과 보안을 동시에 제공합니다.
• GitHub에서 open-source로 제공되며, 커스터마이징이 용이합니다.
• 즉시 적용 가능한 Bash 스크립트를 사용해 CHANGELOG.md를 간편하게 관리하세요.