GitHub is a developer platform that lets you manage projects and teams, follow projects, host code, and maintain documentation. Using the GitHub extension for Zoho Desk, customer support agents can easily track and manage issues added to GitHub repositories without leaving Zoho Desk.
Installing the extension
You can install the GitHub extension either from the Zoho Marketplace or from your Zoho Desk account.
To install from Zoho Desk:
- Log in to your Zoho Desk account with Administrator privileges.
- Click the Setup icon ( ) in the top bar.
- Under Marketplace, click All.
- Search for 'GitHub' in the search bar on the right.
- Select the GitHub for Zoho Desk extension, then click Install.
- Under General Settings, select the department and profiles whose agents can access the extension in Zoho Desk.
- Agree to the Terms of Use, then click Install.
- Click Authorize, then click Accept to authorize Zapps to activate the extension.
- Click Authorize, then click Accept to authorize your Zoho OAuth service.
- Click Authorize, and authorize with your Github credentials.
- Under Configuration, provide your githuborgname.
- Click Save.
Upon successful installation, the extension can be accessed from the right panel of the ticket detail page.
Linking issues to tickets
With the GitHub extension, you can link any existing issues within a repository in Github with a ticket in Zoho Desk. You can even link multiple issues to a single ticket.
To link an issue:
- Go to the Tickets module.
- Click on the ticket you want the issue to link with.
- In the widget, you will be asked to configure the github repository.
- Click Ok.
- Select the desired repository to link from the drop-down.
- Click Save Changes.
- Select the desired issue from the drop-down to link with the ticket.
- Add labels for the issue, if required.
- Click Link issue.
The issue will be linked with the ticket and the details will be shown as a comment.
Managing issues in tickets
With this extension, you can create new issues for a ticket, link issues to tickets, and remove issues from tickets, all from within Zoho Desk. Any issues created in Zoho Desk will be reflected in Github, but issues removed in Desk will not.
To create an issue:
- Go to the Tickets module.
- Click on the ticket for which you want to create an issue.
- Click # (create issue) icon.
- The selected GitHub repository will be shown by default.
- Enter an Issue Title.
- Provide a Description for the ticket.
- Add Issue Labels.
- Add Assignees to the issue.
- Click Submit.
The issue will be created and linked with the ticket, and the details will be shown as a comment.
To link an issue:
- Go to the Tickets module.
- Click on the ticket for which you want to link an issue.
- Click the Link icon.
- Select the desired issue from the drop-down to link with the ticket.
- Add labels for the issue, if required.
- Click Link issue.
The issue will be linked with the ticket and the details will be shown as a comment.
To remove an issue:
- Go to the Tickets module.
- Click on the ticket for which you want to remove an issue.
- Click the (edit) icon.
The issues that are linked to the ticket will be listed.
- Click Remove next to the issue title.
- Click Confirm.
Manage extension settings
You can manage the actions triggered in the extension in the Settings tab anytime. To manage the extension settings:
- Click (Settings) icon in the widget.
- In Create Desk Ticket Comments, choose the comments to be public or private.
- In Choose which list sections user can see, select the sections that can be visible to the user.
- In Display linked issue, select the fields to be while listing the issues in the widget.
- Click Save Changes.
Note: To view the Commits & Affected files information for an issue, the commit title should contain keyword in the below format.
zd#<Desk ticket number>space<commit name> (zd#577 commit 1)
Uninstalling the extension
- Click the Setup icon () in the top bar.
- In the Setup Landing page, click All under Marketplace.
- In the Marketplace page, click Installed Extensions.
- Choose GitHub for Zoho Desk from the list of extensions.
- Click the More icon () in the upper-right corner of the GitHub for Zoho Desk extension setup page.
- Select Uninstall Extension.
- Click Confirm.