Skip to content

Commit 974b2c1

Browse files
committed
Fix documentation
1 parent 48662b6 commit 974b2c1

File tree

2 files changed

+18
-16
lines changed

2 files changed

+18
-16
lines changed

REFERENCE.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -1186,28 +1186,29 @@ Default value: `$gitlab::skip_post_deployment_migrations`
11861186
### <a name="gitlab--custom_hook"></a>`gitlab::custom_hook`
11871187

11881188
Custom hooks can be created as a pre-receive, post-receive, or update hook.
1189-
It is possible to create different custom hook types for the same project - one each for pre-receive, post-receive and update.
1189+
Only one of each is currently supported by this module.
11901190

11911191
#### Examples
11921192

11931193
##### Custom hook usage
11941194

11951195
```puppet
11961196
gitlab::custom_hook { 'my_custom_hook':
1197-
namespace => 'my_group',
1198-
project => 'my_project',
1199-
type => 'post-receive',
1200-
source => 'puppet:///modules/my_module/post-receive',
1197+
namespace => 'my_group',
1198+
project => 'my_project',
1199+
type => 'post-receive',
1200+
source => 'puppet:///modules/my_module/post-receive',
12011201
}
12021202
```
12031203

12041204
##### Calculate hashed storage path
12051205

12061206
```puppet
12071207
gitlab::custom_hook { 'my_custom_hook':
1208-
project => 93,
1209-
type => 'post-receive',
1210-
source => 'puppet:///modules/my_module/post-receive',
1208+
project => 93,
1209+
hashed_storage => true,
1210+
type => 'post-receive',
1211+
source => 'puppet:///modules/my_module/post-receive',
12111212
}
12121213
# Hook path will be `@hashed/6e/40/6e4001871c0cf27c7634ef1dc478408f642410fd3a444e2a88e301f5c4a35a4d`
12131214
```

manifests/custom_hook.pp

+9-8
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,22 @@
22
# Manage custom hook files within a GitLab project.
33
#
44
# Custom hooks can be created as a pre-receive, post-receive, or update hook.
5-
# It is possible to create different custom hook types for the same project - one each for pre-receive, post-receive and update.
5+
# Only one of each is currently supported by this module.
66
#
77
# @example Custom hook usage
88
# gitlab::custom_hook { 'my_custom_hook':
9-
# namespace => 'my_group',
10-
# project => 'my_project',
11-
# type => 'post-receive',
12-
# source => 'puppet:///modules/my_module/post-receive',
9+
# namespace => 'my_group',
10+
# project => 'my_project',
11+
# type => 'post-receive',
12+
# source => 'puppet:///modules/my_module/post-receive',
1313
# }
1414
#
1515
# @example Calculate hashed storage path
1616
# gitlab::custom_hook { 'my_custom_hook':
17-
# project => 93,
18-
# type => 'post-receive',
19-
# source => 'puppet:///modules/my_module/post-receive',
17+
# project => 93,
18+
# hashed_storage => true,
19+
# type => 'post-receive',
20+
# source => 'puppet:///modules/my_module/post-receive',
2021
# }
2122
# # Hook path will be `@hashed/6e/40/6e4001871c0cf27c7634ef1dc478408f642410fd3a444e2a88e301f5c4a35a4d`
2223
#

0 commit comments

Comments
 (0)