What Syncs from GitLab
This page lists the GitLab events Git-Zen acts on, and the events it ignores.
Events Git-Zen uses
Section titled “Events Git-Zen uses”| GitLab webhook event | What Git-Zen does |
|---|---|
| Push events | Adds commits with a gz# tag to the ticket. Comments if Upon commit push is on. Lists the affected files. |
| Issues events and Confidential issues events | Updates the linked issue in the sidebar. Comments on the ticket for the changes below. Runs field sync from GitLab. |
| Comments and Confidential comments | Copies issue comments to the ticket if Upon issue comment is on. |
Issue changes that Git-Zen reports on the ticket, when Upon change to issue property is on:
- State: closed or reopened
- Labels added or removed
- Assignees changed
- Milestone changed
- Weight set or removed
- Due date set or removed
- Iteration set or removed
When the issue closes, Git-Zen can also add tags to the ticket and solve it. See Zendesk tags and Closed ticket updates.
Events Git-Zen ignores
Section titled “Events Git-Zen ignores”- Merge request events. Git-Zen does not post merge request activity to tickets. To connect code to a ticket, add a
gz#tag to a commit message. See Linking commits. - Release events. Release notifications are available for GitHub only.
- Pipeline, tag push, wiki, and other events. Git-Zen does not use them. You do not need to turn them on.
Skip a comment
Section titled “Skip a comment”Add gz#skip to a GitLab comment to keep it out of Zendesk.
Force a comment
Section titled “Force a comment”If Upon issue comment is off, add gz#force to a GitLab comment to send that one comment anyway. Git-Zen removes the keyword from the text it sends. gz#force does not get around the comment filters. See Ticket comments.
Match commenters to Zendesk users
Section titled “Match commenters to Zendesk users”Git-Zen tries to show each GitLab comment as written by the matching Zendesk user. It looks up the commenter’s public GitLab email address in Zendesk.
GitLab hides most email addresses. When the email is hidden, Git-Zen looks for a Zendesk user with this pseudo-email address:
[gitlab_username]@git-zen.internal
For the GitLab user “SuperCoder”, add SuperCoder@git-zen.internal as a secondary email on the agent’s Zendesk profile.
Issue and comment events need the Full version. On Git-Zen Lite, Git-Zen uses only push events, for commit linking. See Plans and billing.