gitlab_hook: Update documentation (#61837)

* Update docs for note_events

Fixes: #61833

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/61838/head
Abhijeet Kasurde 6 years ago committed by GitHub
parent e06dbe6e4f
commit 223dab99ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -40,7 +40,7 @@ options:
- access_token - access_token
project: project:
description: description:
- Id or Full path of the project in the form of group/name - Id or Full path of the project in the form of group/name.
required: true required: true
type: str type: str
hook_url: hook_url:
@ -50,54 +50,55 @@ options:
type: str type: str
state: state:
description: description:
- When C(present) the hook will be updated to match the input or created if it doesn't exist. When C(absent) it will be deleted if it exists. - When C(present) the hook will be updated to match the input or created if it doesn't exist.
- When C(absent) hook will be deleted if it exists.
required: true required: true
default: present default: present
type: str type: str
choices: [ "present", "absent" ] choices: [ "present", "absent" ]
push_events: push_events:
description: description:
- Trigger hook on push events - Trigger hook on push events.
type: bool type: bool
default: yes default: yes
issues_events: issues_events:
description: description:
- Trigger hook on issues events - Trigger hook on issues events.
type: bool type: bool
default: no default: no
merge_requests_events: merge_requests_events:
description: description:
- Trigger hook on merge requests events - Trigger hook on merge requests events.
type: bool type: bool
default: no default: no
tag_push_events: tag_push_events:
description: description:
- Trigger hook on tag push events - Trigger hook on tag push events.
type: bool type: bool
default: no default: no
note_events: note_events:
description: description:
- Trigger hook on note events - Trigger hook on note events or when someone adds a comment.
type: bool type: bool
default: no default: no
job_events: job_events:
description: description:
- Trigger hook on job events - Trigger hook on job events.
type: bool type: bool
default: no default: no
pipeline_events: pipeline_events:
description: description:
- Trigger hook on pipeline events - Trigger hook on pipeline events.
type: bool type: bool
default: no default: no
wiki_page_events: wiki_page_events:
description: description:
- Trigger hook on wiki events - Trigger hook on wiki events.
type: bool type: bool
default: no default: no
hook_validate_certs: hook_validate_certs:
description: description:
- Whether GitLab will do SSL verification when triggering the hook - Whether GitLab will do SSL verification when triggering the hook.
type: bool type: bool
default: no default: no
aliases: [ enable_ssl_verification ] aliases: [ enable_ssl_verification ]
@ -105,7 +106,7 @@ options:
description: description:
- Secret token to validate hook messages at the receiver. - Secret token to validate hook messages at the receiver.
- If this is present it will always result in a change as it cannot be retrieved from GitLab. - If this is present it will always result in a change as it cannot be retrieved from GitLab.
- Will show up in the X-GitLab-Token HTTP request header - Will show up in the X-GitLab-Token HTTP request header.
required: false required: false
type: str type: str
''' '''

Loading…
Cancel
Save