• 저장소에 서버 훅 설정하기
  • Gitaly 클러스터의 서버 후크
• 모든 저장소에 대한 전역 서버 후크 생성
  • 서버 후크 디렉토리 선택
  • 전역 서버 후크 생성
• 저장소에 대한 서버 후크 제거
• 연쇄적 서버 후크
• 서버 훅에서 사용 가능한 환경 변수
• 사용자 정의 오류 메시지

Git 서버 훅

• GitLab 12.8에서 사용이 시작되어 사용자 정의 훅을 대체했습니다.
• GitLab 15.6에서 서버 훅을 Git 서버 훅으로 이름이 변경되었습니다.

Git 서버 훅(시스템 훅(system hooks)[(system_hooks.md)]이나 파일 훅(file hooks)[(file_hooks.md)]과 혼동하면 안 됨)은 GitLab 서버에서 사용자 정의 논리를 실행합니다. 이를 사용하여 다음과 같은 Git 관련 작업을 수행할 수 있습니다.

• 특정 커밋 정책 강제
• 저장소 상태에 기반한 작업 수행

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

GitLab 관리자는 Gitaly 명령을 사용하여 서버 훅을 구성하며, 이 명령은 또한 다음을 수행합니다.

• Gitaly 서버를 시작하는 데 사용됨
• 여러 하위 명령을 제공함
• Gitaly gRPC API에 연결함

gitaly 명령에 액세스할 수 없으면 서버 훅의 대체로 다음을 사용할 수 있습니다.

• 웹훅
• GitLab CI/CD
• 사용자 구성 가능한 Git 훅 인터페이스인 푸시 규칙

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

저장소에 서버 훅 설정하기

Gitaly 클러스터의 서버 후크

만약 Gitaly 클러스터를 사용한다면, 개별 저장소는 Praefact 내의 여러 Gitaly 저장소로 복제될 수 있습니다. 결과적으로 후크 스크립트는 해당 저장소의 복제본을 가지고 있는 모든 Gitaly 노드로 복사되어야 합니다. 이를 위해 해당 버전에 맞는 사용자 지정 저장소 후크 설정을 위해 동일한 단계를 따르고 각 저장소에 대해 반복하면 됩니다.

스크립트를 복사할 위치는 저장소가 저장되는 위치에 달려 있습니다:

• GitLab 15.2 이전에는 Gitaly 클러스터가 GitLab 애플리케이션에서 보고하는 해시된 저장소 경로를 사용합니다.
• GitLab 15.3 이후에는 새로운 저장소는 Praefect에서 생성된 복제 경로를 사용하여 생성됩니다. 이 복제 경로는 해시된 저장소 경로가 아닙니다. 복제 경로는 Praefect 저장소 메타데이터를 조회하여 GitLab 해시된 저장소 경로를 명시하는데 -relative-path를 사용하여 식별할 수 있습니다.

모든 저장소에 대한 전역 서버 후크 생성

모든 저장소에 적용되는 Git 후크를 만들려면 전역 서버 후크를 설정하세요. 전역 서버 후크는 또한 다음에도 적용됩니다:

• 프로젝트 및 그룹 위키 저장소. 그들의 저장소 디렉토리 이름은 다음 형식을 따릅니다 <id>.wiki.git.
• 프로젝트 아래의 디자인 관리 저장소. 그들의 저장소 디렉토리 이름은 다음 형식을 따릅니다 <id>.design.git.

서버 후크 디렉토리 선택

전역 서버 후크를 만들기 전에 해당 후크를 위한 디렉토리를 선택해야 합니다.

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

• 기본 제안인 /var/opt/gitlab/gitaly/custom_hooks 디렉토리를 주석 처리 해제하여 사용합니다.
• 나만의 설정을 추가하세요.

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

• 디렉토리는 설정 파일에서 설정됩니다. 설정 파일의 위치는 GitLab 버전에 따라 다릅니다:
  • GitLab 13.1 이후 버전에 대해, 디렉토리는 [hooks] 섹션에서 gitaly/config.toml에 설정됩니다. 그러나, gitaly/config.toml의 값이 공백이거나 존재하지 않으면 GitLab은 gitlab-shell/config.yml의 custom_hooks_dir 값을 적용합니다.
  • GitLab 13.0 이전 버전에 대해, 디렉토리는 gitlab-shell/config.yml에 설정됩니다.
• 기본 디렉토리는 /home/git/gitlab-shell/hooks 입니다.

전역 서버 후크 생성

모든 저장소에 대한 전역 서버 후크를 만들려면:

1. GitLab 서버에서 구성된 전역 서버 후크 디렉토리로 이동합니다.
2. 구성된 전역 서버 후크 디렉토리에서, 후크 유형과 일치하는 후크용 디렉토리를 생성합니다. 예를 들어 pre-receive 서버 후크의 경우 디렉토리 이름은 pre-receive.d여야 합니다.
3. 이 새로운 디렉토리 안에 서버 후크를 추가하세요. Git 서버 후크는 모든 프로그래밍 언어로 작성될 수 있습니다. 상단에 있는 shebang가 언어 유형을 반영하도록 하세요. 예를 들어, 스크립트가 루비 언어로 되어 있다면 shebang는 아마도 #!/usr/bin/env ruby일 것입니다.
4. 후크 파일을 실행 가능한 상태로 만들고, Git 사용자의 소유인지 확인하고, 백업 파일 패턴(*~)과 일치하지 않도록 확인하세요.

만약 서버 후크 코드가 올바르게 구현되었다면, 다음으로 트리거된 경우 Git 후크가 실행되어야 합니다. 서버 후크는 후크 유형 하위 디렉토리의 파일 이름에 따라 알파벳 순으로 실행됩니다.

저장소에 대한 서버 후크 제거

cat empty_hooks.tar | sudo /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