gitsnitch

프로그램 소개

GitSnitch는 Git 커밋 이력을 정의된 규칙 세트에 대조하여 검사하는 선언적 정책 엔진입니다. 팀은 저장소 표준을 점진적으로 도입하고 강제할 수 있으며, 로컬 개발자 환경부터 CI/CD 파이프라인에 이르기까지 다양한 워크플로우에 통합하여 사용할 수 있습니다.

주요 기능

• 메시지 규칙: 커밋 제목, 본문 또는 전체 메시지에 대한 정규 표현식 패턴 검사를 지원합니다.
• 차이(Diff) 규칙: 파일 경로를 제한하거나, 금지된 패턴을 감지하고, 라인 수 임계값을 강제할 수 있습니다.
• 맥락 인식 스킵: 특정 조건(예: 유지보수 브랜치)에서 규칙을 선택적으로 건너뛸 수 있습니다.
• 심각도 밴드: 심각도 0-250을 ‘Information’, ‘Warning’, ‘Error’, ‘Fatal’로 매핑합니다.
• 종료 코드 매핑: 선택적으로 위반 심각도를 종료 코드로 변환하여 CI 자동화에 활용할 수 있습니다.
• 시작 presets: ‘conventional-commits’, ‘forbid-wip’ 등 내장된 Assertion 번들을 ‘–preset’ 플래그로 적용할 수 있습니다.

다운로드 및 설치 방법

GitSnitch는 Rust 기반으로 여러 방법을 통해 설치할 수 있습니다.

• Windows (Chocolatey 사용 시): PowerShell에서 다음 명령어로 설치할 수 있습니다.
  choco install gitsnitch
• macOS 또는 Linux (Homebrew 사용 시): 다음 명령어로 설치할 수 있습니다.
  brew tap iilei/tap
brew install --formula iilei/tap/gitsnitch
• cargo-binstall 사용 시: Rust 패키지 매니저를 통해 설치할 수 있습니다.
  cargo binstall gitsnitch

기본 사용법 및 명령어

GitSnitch는 두 가지 기본 모드로 작동합니다. 하나의 커밋을 검사하거나, 두 리프 사이의 범위를 검사할 수 있습니다.

• 단일 커밋 검사: gitsnitch --commit-sha <sha> 명령어를 사용합니다.
• 커밋 범위 검사 (PR 린팅): 소스 리프와 대상 리프를 지정하여 검사합니다.
  gitsnitch --source-ref "<source_ref>" --target-ref "<target_ref>" --config .gitsnitch.toml --violation-severity-as-exit-code
• 프리셋 적용: --preset 플래그를 사용하여 사전 정의된 규칙 세트를 적용할 수 있습니다. 예를 들어, 컨벤셔널 커밋과 WIP 금지 규칙을 동시에 적용하려면:
  gitsnitch --preset conventional-commits --preset forbid-wip --commit-sha <sha>
• 출력 형식: 기본적으로 JSON 형식으로 출력되며, --output-format text-plain 플래그로 사람이 읽기 쉬운 텍스트 형식으로 변경할 수 있습니다.

이런 경우에 유용합니다

• 팀 저장소 표준 정착: 커밋 메시지 형식이나 코드 변경 패턴 같은 팀 규칙을 자동화하여 일관된 이력을 만들 때 유용합니다.
• CI/CD 자동화 통합: 파이프라인 내에서 커밋 품질을 검증하고, 심각도에 따라 빌드를 차단하거나 경고하는 등 강제 수준을 조절할 때 활용할 수 있습니다.
• 점진적 도입: 기존 워크플로우를 갑자기 바꾸지 않고, 규칙을 관찰 목적으로 시작하여 점차 경고, 그리고 최종적으로 강제 규칙으로 발전시키는 데 적합합니다.

지원 환경 및 시스템 요구사항

GitSnitch는 Windows, macOS, Linux 환경에서 사용할 수 있는 크로스 플랫폼 도구입니다. 실행을 위해 Git 설치가 필요하며, CI 환경에서 셀로우 클론을 검사할 때는 Origin에서 git fetch를 수행할 수 있는 인증 정보가 필요할 수 있습니다.

제한 사항 및 확인 사항

• Git 저장소 필수: GitSnitch는 Git 저장소 내에서 실행되어야 합니다. 저장소 외부에서 실행하면 설정 파일을 찾지 못하거나 오류가 발생할 수 있습니다.
• CI 환경 인증: CI/CD 환경에서 셀로우 클론을 자동으로 수정(autoheal)할 때는 Origin에 대한 git fetch 권한이 있는 인증 정보(GitHub 토큰 등)가 설정되어 있어야 합니다.
• 설정 파일: 규칙을 정의하는 설정 파일(.gitsnitch.toml 등)이 없으면 기본 설정으로 동작하며, 이 경우 아무런 Assertion도 실행하지 않습니다.

FAQ

• 무료로 사용할 수 있나요? 네, GitSnitch는 MIT 라이선스로 배포되는 오픈소스 소프트웨어로 무료로 사용할 수 있습니다.
• Windows에서 사용할 수 있나요? 네, Windows를 포함한 모든 주요 운영 체제에서 사용할 수 있습니다. Chocolatey 패키지 매니저를 통해 편리하게 설치할 수 있습니다.