• 저장소에 서버 훅 설정하기
  • Gitaly 클러스터에서의 서버 후크
• 모든 저장소에 대한 전역 서버 후크 생성
  • 서버 후크 디렉터리 선택
  • 전역 서버 후크 생성
• 저장소의 서버 후크 제거
• 연쇄형 서버 후크
• 커스텀 오류 메시지

Git 서버 훅

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

Git 서버 훅(시스템 훅 또는 파일 훅과 혼동해서는 안 됨)은 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 클러스터를 사용 중이라면, 개별 저장소는 Praefect의 여러 Gitaly 스토리지에 복제될 수 있습니다. 이에 따라 후크 스크립트는 해당 저장소의 복제본을 가진 각 Gitaly 노드로 복사되어야 합니다. 이를 위해 해당 버전에 대한 사용자 지정 저장소 후크 설정 절차를 반복하고, 각 스토리지에 대해 동일한 단계를 수행하면 됩니다.

스크립트를 복사해야 할 위치는 저장소가 저장되는 위치에 따라 달라집니다:

• GitLab 15.2 이전에는 Gitaly 클러스터가 GitLab 애플리케이션에서 보고하는 해시된 저장소 경로를 사용합니다.
• GitLab 15.3 이후에는 새로운 저장소는 Praefect가 생성한 복제 경로를 사용하며, 이는 해시된 저장소 경로가 아닙니다. 복제 경로는 예상되는 GitLab 해시된 저장소 경로를 지정하기 위해 -relative-path를 사용하여 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에 설정됩니다. 그러나, 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 서버 후크는 모든 프로그래밍 언어로 작성할 수 있습니다. 상단에 있는 shebang이 해당 언어 유형을 반영하도록 주의하세요. 예를 들어, 스크립트가 Ruby로 작성되었다면 shebang는 아마도 #!/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/*: 모든 실행 가능한 전역 후크 파일의 위치입니다. (백업 파일 제외)

서버 후크 디렉터리 내에서, 후크:

• 알파벳 순으로 실행됩니다.
• 후크가 0이 아닌 값으로 종료되면 실행이 중지됩니다.

서버 후크에 사용 가능한 환경 변수

서버 후크에는 어떤 환경 변수든 전달할 수 있지만, 지원되는 환경 변수에만 의존해야 합니다.

다음 GitLab 환경 변수는 모든 서버 후크에서 지원됩니다:

다음 Git 환경 변수는 pre-receive와 post-receive 서버 후크에 대해 지원됩니다:

커스텀 오류 메시지

GitLab UI에 사용자 정의 오류 메시지를 표시할 수 있습니다. 커밋이 거부되거나 Git 후크 중에 오류가 발생할 때 사용자 정의 오류 메시지가 나타납니다. 커스텀 오류 메시지를 표시하려면 다음과 같이 스크립트를 작성해야 합니다:

• 커스텀 오류 메시지를 스크립트의 stdout 또는 stderr로 보냅니다.
• 각 메시지를 GL-HOOK-ERR:로 시작하며, 접두사 이전에 어떤 문자도 나타나지 않습니다.

예를 들면:

#!/bin/sh
echo "GL-HOOK-ERR: 내 커스텀 오류 메시지.";
exit 1