Skip to content
Git-ZenDocs

GitHub: Release Notifications

Full Version Only.

Git-Zen can add a comment to a Zendesk ticket when a GitHub release that includes its fix is published. Your agents can then tell the customer that the fix is live.

The comment reads:

A GitHub release that references this ticket has been published: v2.4.0 – Spring release

The tag name and release title link to the release on GitHub.

Turn on release notifications

Section titled “Turn on release notifications”
  1. Click Settings on the Git-Zen menu bar.
  2. Under Create Zendesk Ticket Comments, turn on Upon release published.
  3. Choose Internal or Public for the comment. The default is internal.
  4. Click Save.

The repository webhook must send the Releases event. Webhooks that Git-Zen creates include it. If you added the webhook manually, check Releases in the webhook’s event list.

How Git-Zen finds the tickets

Section titled “How Git-Zen finds the tickets”

Git-Zen reads the release title and release notes. It then follows this chain:

  1. It finds numbers written as #123, GH-123, owner/repo#123, or as a full link to a pull request or issue in the same repository (such as https://github.com/owner/repo/pull/123). It treats each one as a pull request.
  2. It reads the description of each pull request. It finds the issue numbers in it, such as Fixes #45.
  3. It finds the Zendesk tickets linked to each of those issues. It uses the gz# tags in the issue description and the links that Git-Zen stores.
  4. It also adds any ticket named directly in the release notes with a gz# tag.

Git-Zen then comments on each ticket it found.

Write release notes that Git-Zen can read

Section titled “Write release notes that Git-Zen can read”
  • Write #123 at the start of a line or after a space or punctuation mark. For example, write #123 Fix login, - Fix login (#123), or Fixes #123.
  • Git-Zen does not match #123 inside a word, ##123, or a number from another repository, such as other/repo#123.
  • Git-Zen follows full links to pull requests and issues in the same repository. GitHub’s automatically generated release notes use full links, so you do not need to change them.
  • Issue numbers listed directly in the release notes are not checked for tickets. List the pull request, or add the gz# tag.
  • If you are not sure, add the ticket tag directly: gz#5678.

When Git-Zen does not comment

Section titled “When Git-Zen does not comment”

Git-Zen skips the release when:

  • The release action is not published. Creating or editing a release does nothing.
  • The release is a draft.
  • The release is marked as a pre-release.
  • Upon release published is off.
  • The ticket is closed or does not exist.