• 리포지토리에 대한 서버 훅 설정
  • Gitaly 클러스터에서의 서버 훅
• 모든 리포지토리를 위한 전역 서버 훅 생성
  • 서버 훅 디렉토리 선택
  • 전역 서버 훅 생성
• 저장소에서 서버 훅 제거하기
• 연결된 서버 훅
• 서버 훅에 제공되는 환경 변수
• 사용자 정의 오류 메시지

Git 서버 훅

• 서버 훅에서 Git 서버 훅으로 이름이 변경되었습니다. GitLab 15.6.

Git 서버 훅( system hooks 또는 file hooks와 혼동하지 마세요)은 GitLab 서버에서 사용자 정의 로직을 실행합니다. 이 훅을 사용하여 다음과 같은 Git 관련 작업을 수행할 수 있습니다:

• 특정 커밋 정책을 시행합니다.
• 리포지토리 상태에 따라 작업을 수행합니다.

Git 서버 훅은 pre-receive, post-receive, 그리고 update 서버 측 Git 훅을 사용합니다.

GitLab 관리자는 gitaly 명령어를 사용하여 서버 훅을 구성하며, 이 명령어는 또한:

• Gitaly 서버를 시작하는 데 사용됩니다.
• 여러 서브 커맨드를 제공합니다.
• Gitaly gRPC API에 연결합니다.

gitaly 명령어에 대한 접근이 없는 경우 서버 훅의 대안으로는 다음이 있습니다:

• Webhooks.
• GitLab CI/CD.
• 사용자 구성 가능한 Git 훅 인터페이스를 위한 Push rules.

Geo는 서버 훅을 보조 노드에 복제하지 않습니다.

리포지토리에 대한 서버 훅 설정

Gitaly 클러스터에서의 서버 훅

Gitaly Cluster를 사용하는 경우, 개별 리포지토리는 Praefect의 여러 Gitaly 저장소에 복제될 수 있습니다.

결과적으로, 훅 스크립트는 리포지토리의 복사본을 가진 모든 Gitaly 노드에 복사되어야 합니다.

이를 수행하려면 해당 버전에 대한 사용자 정의 리포지토리 훅을 설정하는 동일한 단계를 따르고 각 저장소에 대해 반복합니다.

스크립트를 복사할 위치는 리포지토리가 저장된 위치에 따라 다릅니다:

• GitLab 15.2 및 이전 버전에서는 Gitaly Cluster가 GitLab 애플리케이션에서 보고하는 해시된 저장소 경로를 사용합니다.

• GitLab 15.3 및 이후 버전에서는 새로운 리포지토리가 Praefect 생성 복제 경로를 사용하여 생성되며, 이는 해시된 저장소 경로가 아닙니다. 복제 경로는 -relative-path를 사용하여 예상 GitLab 해시된 저장소 경로를 지정해 Praefect 리포지토리 메타데이터를 쿼리하여 식별할 수 있습니다.

모든 리포지토리를 위한 전역 서버 훅 생성

모든 리포지토리에 적용되는 Git 훅을 생성하려면 전역 서버 훅을 설정합니다. 전역 서버 훅은 다음에도 적용됩니다:

• 프로젝트 및 그룹 위키 리포지토리. 이들의 저장소 디렉토리 이름은 <id>.wiki.git 형식입니다.

• 프로젝트 내 디자인 관리 리포지토리. 이들의 저장소 디렉토리 이름은 <id>.design.git 형식입니다.

서버 훅 디렉토리 선택

전역 서버 훅을 생성하기 전에 디렉토리를 선택해야 합니다.

Linux 패키지 설치의 경우, 디렉토리는 gitlab.rb의 gitaly['configuration'][:hooks][:custom_hooks_dir] 아래에 설정됩니다. 다음 중 하나를 선택합니다:

• 기본 제안인 /var/opt/gitlab/gitaly/custom_hooks 디렉토리를 주석 해제하여 사용합니다.

• 자신만의 설정을 추가합니다.

자체 컴파일된 설치의 경우:

• 디렉토리는 [hooks] 섹션의 gitaly/config.toml에 설정됩니다. 그러나 GitLab은 gitaly/config.toml의 값이 비어 있거나 존재하지 않을 경우 gitlab-shell/config.yml의 custom_hooks_dir 값을 존중합니다.

• 기본 디렉토리는 /home/git/gitlab-shell/hooks입니다.

전역 서버 훅 생성

모든 리포지토리에 대한 전역 서버 훅을 생성하려면:

1. GitLab 서버에서 설정된 전역 서버 훅 디렉토리로 이동합니다.

2. 설정된 전역 서버 훅 디렉토리에서 훅 유형에 맞는 훅 디렉토리를 생성합니다. 예를 들어, pre-receive 서버 훅의 경우 디렉토리 이름은 pre-receive.d여야 합니다.

3. 이 새 디렉토리 안에 서버 훅을 추가합니다. Git 서버 훅은 모든 프로그래밍 언어로 작성할 수 있습니다. 스크립트의 맨 위에 있는 셰뱅이 언어 유형을 반영하는지 확인합니다. 예를 들어, 스크립트가 Ruby로 작성된 경우 셰뱅은 아마도 #!/usr/bin/env ruby일 것입니다.

4. 훅 파일을 실행 가능하게 만들고, Git 사용자 소유로 설정하며 백업 파일 패턴(*~)과 일치하지 않도록 합니다.

서버 훅 코드가 제대로 구현되었다면, Git 훅이 다음에 트리거될 때 실행되어야 합니다. 훅은 훅 유형 하위 디렉토리의 파일 이름에 따라 알파벳순으로 실행됩니다.

저장소에서 서버 훅 제거하기

cat empty_hooks.tar | sudo -u git -- /opt/gitlab/embedded/bin/gitaly hooks set --storage <storage> --repository <relative path> --config <config path>

연결된 서버 훅

GitLab은 서버 훅을 체인 방식으로 실행할 수 있습니다. GitLab은 다음 순서로 서버 훅을 검색하고 실행합니다:

• 내장된 GitLab 서버 훅. 이 서버 훅은 사용자가 사용자 정의할 수 없습니다.
• <project>.git/custom_hooks/<hook_name>: 프로젝트별 훅. 이 위치는 이전 호환성을 위해 유지됩니다.
• <project>.git/custom_hooks/<hook_name>.d/*: 프로젝트별 훅을 위한 위치입니다.
• <custom_hooks_dir>/<hook_name>.d/*: 편집기 백업 파일을 제외한 모든 실행 가능한 글로벌 훅 파일의 위치입니다.

서버 훅 디렉터리 내에서, 훅은:

• 알파벳 순서대로 실행됩니다.
• 훅이 비제로 값으로 종료되면 실행이 중지됩니다.

서버 훅에 제공되는 환경 변수

모든 환경 변수를 서버 훅에 전달할 수 있지만, 지원되는 환경 변수에만 의존해야 합니다.

모든 서버 훅에 대해 지원되는 GitLab 환경 변수는 다음과 같습니다:

pre-receive 및 post-receive 서버 훅에 대해 지원되는 Git 환경 변수는 다음과 같습니다:

사용자 정의 오류 메시지

커밋이 거부되거나 Git 훅에서 오류가 발생할 때 GitLab UI에 사용자 정의 오류 메시지를 표시할 수 있습니다. 사용자 정의 오류 메시지를 표시하려면 스크립트에서 다음을 수행해야 합니다:

• 사용자 정의 오류 메시지를 스크립트의 stdout 또는 stderr로 전송합니다.

• 각 메시지를 GL-HOOK-ERR:로 접두어를 붙이고, 접두어 앞에 다른 문자가 나타나지 않도록 합니다.

예를 들어:

#!/bin/sh
echo "GL-HOOK-ERR: 나의 사용자 정의 오류 메시지.";
exit 1