diff options
| author | Joe Marty <jmarty@iexposure.com> | 2017-10-19 11:18:03 -0500 |
|---|---|---|
| committer | Winnie Hellmann <winnie@gitlab.com> | 2017-10-21 23:32:05 +0300 |
| commit | a6056961b069250c7fb432a6d16292c6c99b8184 (patch) | |
| tree | 34114c4f6cdfbd6e75893387ce4d3cf0b6530984 | |
| parent | f846abdb665443e2f11fd39a74aa10ff0ee7cb34 (diff) | |
| download | gitlab-ce-a6056961b069250c7fb432a6d16292c6c99b8184.tar.gz | |
Clarify the difference between project_update and project_rename
| -rw-r--r-- | changelogs/unreleased/fix-system-hook-docs.yml | 5 | ||||
| -rw-r--r-- | doc/system_hooks/system_hooks.md | 2 |
2 files changed, 7 insertions, 0 deletions
diff --git a/changelogs/unreleased/fix-system-hook-docs.yml b/changelogs/unreleased/fix-system-hook-docs.yml new file mode 100644 index 00000000000..393c84a2eff --- /dev/null +++ b/changelogs/unreleased/fix-system-hook-docs.yml @@ -0,0 +1,5 @@ +--- +title: Clarify system_hook triggers in documentation +merge_request: 14957 +author: Joe Marty +type: other diff --git a/doc/system_hooks/system_hooks.md b/doc/system_hooks/system_hooks.md index 0399ebec86a..a45a4eb9e49 100644 --- a/doc/system_hooks/system_hooks.md +++ b/doc/system_hooks/system_hooks.md @@ -2,6 +2,8 @@ Your GitLab instance can perform HTTP POST requests on the following events: `project_create`, `project_destroy`, `project_rename`, `project_transfer`, `project_update`, `user_add_to_team`, `user_remove_from_team`, `user_create`, `user_destroy`, `key_create`, `key_destroy`, `group_create`, `group_destroy`, `user_add_to_group` and `user_remove_from_group`. +The triggers for most of these are self-explanatory, but `project_update` and `project_rename` deserve some clarification: `project_update` is fired any time an attribute of a project is changed (name, description, tags, etc.) *unless* the `path` attribute is also changed. In that case, a `project_rename` is triggered instead (so that, for instance, if all you care about is the repo URL, you can just listen for `project_rename`). + System hooks can be used, e.g. for logging or changing information in a LDAP server. > **Note:** |