summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSean McGivern <sean@mcgivern.me.uk>2017-10-20 18:26:32 +0000
committerSean McGivern <sean@mcgivern.me.uk>2017-10-20 18:26:32 +0000
commit82397f386a443ae19b7fdd7dcf4dacadbc3f93a5 (patch)
tree2e0d37f6563e92a73b24b5c5b52eef4552e5c17b
parent2c66ea010d1facd1dde4ce5d055bcffceaa6f155 (diff)
parent81eb4ad36827e6cb2090e8e2ae599e5a637910a4 (diff)
downloadgitlab-ce-82397f386a443ae19b7fdd7dcf4dacadbc3f93a5.tar.gz
Merge branch 'fix-system-hook-docs' into 'master'
Clarify system hook docs See merge request gitlab-org/gitlab-ce!14957
-rw-r--r--changelogs/unreleased/fix-system-hook-docs.yml5
-rw-r--r--doc/system_hooks/system_hooks.md2
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:**