• 리포지터리에 서버 후크 설정
  • Gitaly 클러스터에서의 서버 후크
• 모든 리포지터리에 대한 글로벌 서버 후크 생성하기
  • 서버 후크 디렉터리 선택하기
  • 글로벌 서버 후크 생성하기
• 리포지터리에 대한 서버 후크 제거하기
• 연쇄 서버 후크
• 서버 후크에서 사용 가능한 환경 변수
• 사용자 정의 오류 메시지

Git 서버 후크

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

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 후크 인터페이스

Geo는 서버 후크를 보조 노드로 복제하지 않습니다.

리포지터리에 서버 후크 설정

Gitaly 클러스터에서의 서버 후크

Gitaly 클러스터를 사용하는 경우, 개별 리포지터리는 Praefect에서 여러 Gitaly 리포지터리에 복제될 수 있습니다. 따라서 후크 스크립트를 해당 리포지터리의 모든 Gitaly 노드에 복사해야 합니다. 이를 위해 해당 버전의 사용자 정의 리포지터리 후크 설정 단계를 따라야 합니다.

스크립트를 복사해야 할 위치는 리포지터리가 저장되는 위치에 따라 다릅니다.

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

모든 리포지터리에 대한 글로벌 서버 후크 생성하기

모든 리포지터리에 적용되는 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은 gitlab-shell/config.yml의 custom_hooks_dir 값을 존준합니다.
• 기본 디렉터리는 /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/*: 편집기 백업 파일을 제외한 모든 실행 가능한 글로벌 후크 파일의 위치입니다.

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

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

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

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

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

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

사용자 정의 오류 메시지

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

• 각 메시지를 스크립트의 stdout 또는 stderr로 보내야 합니다.
• 각 메시지를 GL-HOOK-ERR:로 접두사를 붙여야 하며, 접두사 앞에 문자가 없어야 합니다.

예를 들어:

#!/bin/sh
echo "GL-HOOK-ERR: My custom error message.";
exit 1