Git-Zen Lite is the FREE version of the simple yet powerful Git-Zen GitHub integration application for Zendesk. Git-Zen coordinates your Zendesk tickets with your GitHub commits. When a Zendesk ticket arrives, and code needs to be changed to correct the issue, you can now easily see which files needed to be changed to correct the issue right next to the ticket. Git-Zen makes it easy to look at past tickets and see exactly what code was changed to correct the issue, in case further troubleshooting is needed in the future. Git-Zen can also keep your agents separate from your developers, so that you do not need to have Zendesk licenses for your development staff.
Easy to Use
To associate a GitHub commit, all you have to do is include the Zendesk ticket number in the comment of the commit, prefaced by "gz#":
this is a comment for gz#12345
See a list of related issues, files, and commits right next to the ticket. Click on a commit link to view the commit in GitHub.
Multiple tickets can be referenced in the same commit comment. Multiple repositories can be referenced; so if a change was required to both your database schema and your web application, all of the changes will be listed together.
Use the LITE version for free, or enjoy the full feature set for less than $20 a month (cost is per Zendesk account; Git-Zen offers an unlimited number of users with each account).
Git-Zen Lite includes the following features:
- Reference ticket from a GitHub commit
- View files affected by a referenced commit
- Unlimited ticket references
- Unlimited users
- File and commit lists limited to 5 items each
The full version of Git-Zen (available from the Zendesk Marketplace) includes all of the features of the Git-Zen Lite, but also includes the following features:
- Create a new GitHub issue directly from Zendesk
- Link multiple existing GitHub issues to a ticket
- Customize which Git-Zen sections are viewable by your agents
- Unlimited file, commit, and issue lists
- Full product support
for more information, please visit our website at https://www.git-zen.com
Git-Zen Installation and Usage
Power User QuickStart Installation
- Install the Git-Zen app from the Zendesk marketplace
- Open any ticket
- Locate Git-Zen in the "Apps" sidebar
- Click "Authorize"
- "Allow" Zendesk access
- "Authorize" GitHub access
- Refresh entire Zendesk browser window
IMPORTANT: You MUST refresh the entire browser window that is currently running Zendesk; do not click simply click the "reload all apps" button, as this will re-start the authorization process
How to use Git-Zen
To associate a GitHub commit or issue, all you have to do is include the Zendesk ticket number in the comment of a GitHub commit or issue, prefaced by "gz#"; in the below example, the Zendesk ticket number is 12345:
this is a comment for gz#12345
You may add more than one ticket number in the same commit (or issue) comment; both tickets will have the commit (or issue) added to it in Git-Zen.
gz#12345 and gz#67890 were affected by this commit
You may add commits from different repositories to the same ticket; this is especially useful when a solution to a ticket is spread across multiple projects, such as a when a change is required to both a database schema and a web application in order to solve an issue.
Git-Zen installation is quick and easy; Git-Zen will step you through the process. Git-Zen requires two different access points in order to function:
- Access to your Zendesk tickets
- Access to your GitHub repositories
Once the Git-Zen application is installed in Zendesk, open any Zendesk ticket. Then, open the "Apps" sidebar. The Git-Zen application should be visible. You will be directed to begin the authorization process:
When you click "Authorize", a separate window will open requesting access to your Zendesk account; this is accomplished through a Zendesk OAUTH token (which can be revoked at any time in your Zendesk user account "security" settings tab). If you are not logged in to Zendesk, you will be asked to log in at this point.
After clicking "Allow" on the Zendesk authorization screen, you will be taken to the authorization screen for your GitHub repositories. If you are not logged in to GitHub, you will be asked to log in here.
Once you authorize Git-Zen to access GitHub, the authorization window will close. Return to your Zendesk window, and refresh the Zendesk window. IMPORTANT: You MUST refresh the entire browser window that is currently running Zendesk; do not click simply click the "reload all apps" button, as this will re-start the authorization process.
You should now see the full Git-Zen application in the app sidebar. There will be a "Link GitHub" icon on the Git-Zen menu bar.
Click this icon to view your available GitHub repositories, and select which repositories you wish to have active for Git-Zen. Then, click the "Save Changes" button.
Git-Zen is ready to use!
Using Git-Zen without authorizing GitHub (optional)
If you do not wish to authorize Git-Zen to access your GitHub repositories automatically, you can still use Git-Zen by adding webhooks manually to your GitHub repostories. To do this, you will need your webhook URL from the Git-Zen menu.
First, complete the above steps (including the Zendesk authorization), but close the window when you are asked to authorize GitHub. Then, refresh your Zendesk browser window. Click on the "Link GitHub" menu at the top of the Git-Zen application:
On the subsequent settings screen, find the section titled "Manual GitHub Configuration". This section will have a unique webhook URL for you to use.
Copy this URL to your clipboard, and then follow these steps:
- Sign in to GitHub, then select the desired repository
- Click on "Settings" from the top repository menu
- Click on "Webhooks" from the left panel
- Click the "Add WebHook" button
- Paste the copied URL in the "Payload URL" field
- Select "application/json" as the content type
- Leave the "Secret" field blank
- Leave SSL verification set to "Enable SSL verification"
- Select "Let me select individual events", and check "Commit comments", "Issues", "Pushes", and "Issue comments"
- Leave the "Active" checkbox checked
- Click the "Add webhook" button
Repeat these steps for each repository that you wish to use with Git-Zen. The same URL is used for every repository.