Skip to content
GitLab
菜单
为什么选择 GitLab
定价
联系销售
探索
为什么选择 GitLab
定价
联系销售
探索
登录
获取免费试用
主导航
搜索或转到…
项目
GitLab
管理
动态
成员
标记
计划
议题
议题看板
里程碑
迭代
需求
代码
合并请求
仓库
分支
提交
标签
仓库图
比较修订版本
代码片段
锁定的文件
构建
流水线
作业
流水线计划
测试用例
产物
部署
发布
Package registry
Container registry
模型注册表
运维
环境
Terraform 模块
监控
事件
服务台
分析
价值流分析
贡献者分析
CI/CD 分析
仓库分析
代码评审分析
议题分析
洞察
模型实验
效能分析
帮助
帮助
支持
GitLab 文档
比较 GitLab 各版本
社区论坛
为极狐GitLab 提交贡献
提交反馈
隐私声明
快捷键
?
新增功能
4
代码片段
群组
项目
显示更多面包屑
gitlab-cn
GitLab
提交
def1b66b
未验证
提交
def1b66b
编辑于
5 years ago
作者:
Cindy Pallares
浏览文件
操作
下载
补丁
差异文件
Add guide to custom global hooks
上级
19115210
No related branches found
No related tags found
加载中
变更
1
隐藏空白变更内容
行内
左右并排
显示
1 个更改的文件
doc/administration/custom_hooks.md
+44
-21
44 个添加, 21 个删除
doc/administration/custom_hooks.md
有
44 个添加
和
21 个删除
doc/administration/custom_hooks.md
+
44
−
21
浏览文件 @
def1b66b
# Custom Git
H
ooks
# Custom
server-side
Git
h
ooks
> **Note:** Custom Git hooks must be configured on the filesystem of the GitLab
NOTE:
**Note:**
Custom Git hooks must be configured on the filesystem of the GitLab
server. Only GitLab server administrators will be able to complete these tasks.
Please explore [webhooks] and [CI] as an option if you do not
have filesystem access. For a user configurable Git hook interface, see
...
...
@@ -14,15 +15,14 @@ See [Git SCM Server-Side Hooks][hooks] for more information about each hook type
As of gitlab-shell version 2.2.0 (which requires GitLab 7.5+), GitLab
administrators can add custom git hooks to any GitLab project.
##
Setup
##
Create a custom Git hook for a repository
Normally, Git hooks are placed in the repository or project's
`hooks`
directory.
GitLab creates a symlink from each project's
`hooks`
directory to the
gitlab-shell
`hooks`
directory for ease of maintenance between gitlab-shell
upgrades. As such, custom hooks are implemented a little differently. Behavior
is exactly the same once the hook is created, though.
Follow the steps below to set up a custom hook:
Server-side Git hooks are typically placed in the repository's
`hooks`
subdirectory. In GitLab, hook directories are are symlinked to the gitlab-shell
`hooks`
directory for ease of maintenance between gitlab-shell upgrades.
Custom hooks are implemented differently, but the behavior is exactly the same
once the hook is created. Follow the steps below to set up a custom hook for a
repository:
1.
Pick a project that needs a custom Git hook.
1.
On the GitLab server, navigate to the project's repository directory.
...
...
@@ -42,33 +42,56 @@ Follow the steps below to set up a custom hook:
That's it! Assuming the hook code is properly implemented the hook will fire
as appropriate.
## Set a global Git hook for all repositories
To create a Git hook that applies to all of your repositories in
your instance, set a global Git hook. Since all the repositories'
`hooks`
directories are symlinked to gitlab-shell's
`hooks`
directory, adding any hook
to the gitlab-shell
`hooks`
directory will also apply it to all repositories. Follow
the steps below to properly set up a custom hook all for repositories:
1.
On the GitLab server, navigate to the configured custom hook directory. The
default is in the gitlab-shell directory. The gitlab-shell
`hook`
directory
for an installation from source the path is usually
`/home/git/gitlab-shell/hooks`
. For Omnibus installs the path is usually
`/opt/gitlab/embedded/service/gitlab-shell/hooks`
.
To look in a different directory for the global custom hooks,
set
`custom_hooks_dir`
in the gitlab-shell config. For
Omnibus installations, this can be set in
`gitlab.rb`
; and in source
installations, this can be set in
`gitlab-shell/config.yml`
.
1.
Create a new directory in this location. Depending on your hook, it will be
either a
`pre-receive.d`
,
`post-receive.d`
, or
`update.d`
directory.
1.
Inside this new directory, add your hook. Hooks can be
in any language. Ensure the 'shebang' at the top properly reflects the language
type. For example, if the script is in Ruby the shebang will probably be
`#!/usr/bin/env ruby`
.
1.
Make the hook file executable and make sure it's owned by Git.
Now test the hook to see that it's functioning properly.
## Chained hooks support
> [Introduced][93] in GitLab Shell 4.1.0 and GitLab 8.15.
Hooks can be also placed in
`hooks/<hook_name>.d`
(global) or
`custom_hooks/<hook_name>.d`
(per project) directories supporting chained
Hooks can be also global or be set per project directories and support a chained
execution of the hooks.
NOTE:
**Note:**
`<hook_name>.d`
would need to be either
`pre-receive.d`
,
NOTE:
**Note:**
`<hook_name>.d`
would need to be either
`pre-receive.d`
,
`post-receive.d`
, or
`update.d`
to work properly. Any other names will be ignored.
To look in a different directory for the global custom hooks (those in
`hooks/<hook_name.d>`
), set
`custom_hooks_dir`
in gitlab-shell config. For
Omnibus installations, this can be set in
`gitlab.rb`
; and in source
installations, this can be set in
`gitlab-shell/config.yml`
.
NOTE:
**Note:**
Files in
`.d`
directories need to be executable and not match the backup file
pattern (
`*~`
).
The hooks are searched and executed in this order:
1.
`gitlab-shell/hooks`
directory as known to Gitaly
1.
`<project>.git/hooks/<hook_name>`
- executed by
`git`
itself, this is
`gitlab-shell/hooks/<hook_name>`
1.
`<project>.git/hooks/<hook_name>`
- executed by
`git`
itself, this is
symlinked to
`gitlab-shell/hooks/<hook_name>`
1.
`<project>.git/custom_hooks/<hook_name>`
- per project hook (this is already existing behavior)
1.
`<project>.git/custom_hooks/<hook_name>.d/*`
- per project hooks
1.
`<project>.git/hooks/<hook_name>.d/*`
OR
`<custom_hooks_dir>/<hook_name.d>/*`
- global hooks: all executable files (minus editor backup files)
Files in
`.d`
directories need to be executable and not match the backup file
pattern (
`*~`
).
The hooks of the same type are executed in order and execution stops on the
first script exiting with a non-zero value.
...
...
此差异已折叠。
点击以展开。
预览
0%
加载中
请重试
或
添加新附件
.
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
保存评论
取消
想要评论请
注册
或
登录