GitHub integration
Track your code changes and improve and revise them using the developer-friendly platform: GitHub. Integrate your Zoho Sprints team with GitHub and manage repositories.
Availability: Premier and Professional
Region: This feature is not available in the CN region.
Access control: Team Owner
Authorize Github account
- Navigate to
in the upper-right corner.
- Select GitHub.
- Click Authorize.
Zoho Sprints adheres to privacy of your data. So, we receive a consent from you before you start the integration process.
Personal Repository
Personal repository lists all the repositories created in your GitHub account.
Team Repository
Team repository lists all the repositories that are mapped from your personal repository. Once mapped, these repositories can be associated to the projects. Once associated, team members can add or attach commits and pull requests to a work item using quick commands or from the work item details page.
You can also integrate Zoho Sprints app directly from the GitHub marketplace.
Map personal repositories to team repository
- Navigate to
- Select GitHub.
- View the list of repositories in your Personal Repository.
- Hover over the repository name.
- Click the map icon next to the repository name to map the repository to your team.
Associate projects to team repository
You can associate a project from your team to the mapped repositories in the team.
- Navigate to
- Select GitHub.
- View the list of repositories in your Team Repository.
- Click + next to the repository.
- Select the projects and click Update.
You can associate only 50 projects to a team repository.
Quick Commands in Zoho Sprints
Once you are done with mapping of repositories and associating projects to the repositories, you are all set to start attaching commits and pull requests. Here are the supported commands.
Only work item tagging is supported in the pull request comment.
Format | Syntax | Purpose |
#workitem | #<Project Prefix>- <i/I><Item number> Example: #SP-i30 | Represents the work item ID. |
#comment | #workitemid #comment <message1> #comment <message2> Example: #SP-I15 #comment Please share the final build by EOD. #comment Fix the existing issues and update the local build. Note: You can add multiple comments to a single work item. | Adds comment for the work item. |
#status | #workitemid #status <status_name> Example 1: #SP-i20 #status Done Example 2: #SP-i20 #status To_be_Tested Note: 1. If the status name carries multiple words, separate them with an underscore. 2. Statuses are not case sensitive. | Updates the status of the work item. |
#priority | #workitemid #priority <priority_name> Example 1: #SP-i40 #priority Critical Example 2: #SP-i42 #priority Should_be Note: 1. If the priority name carries multiple words, separate them with an underscore. 2. Priorities are not case sensitive. | Updates the priority of the work item. |
#time | #workitemid #time <hours>h <minutes>m Example: #SP-I52 #time 5h 30m | Adds log hours for the work item. |
- You can only attach the commits and pull requests to an item if the project is associated to the repository that you have mapped to your team. And the work item for which you attach the commit should be a part of the associated project.
- The email address of the GitHub user should be registered with the Zoho Sprints team only then they can process the commits: #comment, #time, #status, and #priority.
Advanced commands
Single command for multiple work items
Syntax | #workitemid,#workitemid,#workitemid #comment <message> |
Example | #SM-I25,#SM-I42,#SM-I98 #comment Issues are resolved and updated in the local build. |
What happens? | All the three work items are added with the comment. |
Multiple commands for single work item
Syntax | #workitemid #comment <message>
#priority <priority_name>
#time <
>
h <
>
m #status <status_name> |
Example | #SM-I34 #comment List out the requirements #priority High #time 5h 3m 20s #status In_progress |
What happens? | The work item is added with comment and log hours. It is also updated with status and priority. |
Multiple commands for multiple work items
Syntax | #workitemid,#workitemid,#workitemid #comment <message>
#priority <priority_name>
#time <>h <>m #status <status_name> |
Example | #SM-I34,
#SM-I45,
#SM-I54 #comment List out the requirements #priority High #time 5h 3m #status In_progress |
What happens? | All the three work items are added with comments, log hours and updated with status and priority. |
Attach commits from work item details section
- Navigate to work item details page.
- Select Github from the tabs.
- Click Attach Commit.
- Select the required fields. * All the fields are mandatory.
- Click Attach.
Attach pull requests from work item details section
- Navigate to work item details page.
- Select Github from the tabs.
- Click Attach Pull Request.
- Select the required fields. * All the fields are mandatory.
- Click Attach.
When you add a commit via GitHub or from the work item details page, we trigger a feed message and notification to the work item assignees.
How to copy the work item ID?
It becomes daunting when you specify the project prefix and ID manually. You can just copy the work item ID from the work item details page and paste it in your commit messages and pull request comment.
Delete commits and pull request
You can delete the commit and pull request directly from the work item details page. Hover over the attached commit and pull request and click 
.
Access for commands
Adding comments
- You must be an active project user to tag comments to work items in your commits.
- Anyone can add comments to the work items in the backlog, if they belong to the project.
- You must be a part of the sprint and have the work item assigned to you before you can add comments to it.
- You can also add comments for unassigned work items.
Adding Log hours
- You must be an active user in the project to add log hours to the work items.
- You can log hours for the work items only in active sprint.
- You must be a part of the sprint.
- You can also log hours for unassigned work items and the work items that are assigned to you.
Updating priority
- You must be an active user in the project to update the priority of the work items.
- The priority name that you provide must be an existing priority in the project.
- You can update the priority of the work items only for the active and upcoming sprints and the work items in the backlog.
- You should be the admin, joint admin, or project manager to update the priority of the work items.
- You cannot update the priority of the work items if they are in the closed status.
Updating status
- You must be an active user in the project to update the status of the work items.
- The status name that you mention must be an existing status in the project.
- You can update the status of the work items only in active sprints.
- You can be a sprint owner, assignee, admin, manager, or sprint creator to update the status of the work items.
When you add a commit via GitHub or from the work item details page, we trigger a feed message and notification to users assigned to the work item.
Disassociate projects from repository
You can also disassociate projects from the repository in two different ways.
From the associate project form
- Navigate to
- Select GitHub.
- Select + in the right corner of the mapped repository in your Team Repository.
- Deselect the projects in the Associate Projects form.
- Click Update.
Directly from the Team Repository
- Navigate to
- Select GitHub.
- Click on the count next to the team repository.
- Hover over the project that you want to dissociate.
- Click Remove Project.
What happens when they disassociate projects to the repository?
You can attach quick commits and pull requests to the work items in the project either via GitHub or directly from the work items details section in Zoho Sprints.
Remove repositories from team
- Navigate to
- Select GitHub.
- View the list of repositories in your Team Repository.
- Hover over the repository name.
- Click the unmap icon to the left end of the repository name to unmap the repository from the team.
What happens when the repository is removed from the team?
You can no longer attach commits and pull requests to the work items either via GitHub or directly from the work item details page.
Remove GitHub authorization
You can remove the GitHub account anytime from Zoho Sprints. To do this:
- Navigate to
- Select GitHub.
- Click
- Click Yes, delete.
What happens when the authorization is removed?
Once the repository is mapped to Team Repository, a webhook or subscription is created between both the applications. When the authorization is removed, the integration between both the application is stopped and all the mapped repositories and its associated projects will be removed.
However, the webhook or subscription will not be deleted. If you want to delete the webhook or subscription created when the authorization was invoked, go to your GitHub settings and disable the webhook created for the respective team.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho Forms?
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
Zoho SalesIQ Resources
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Bigin?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
Related Articles
GitLab integration
Manage your GitLab repositories in Zoho Sprints. Map the repositories to relevant projects, attach commits, and pull requests in the work item details page. Availability: Premier and Professional plans Region: This feature is not available in ...Bitbucket integration
Track your code changes, manage your repositories, add commits, and pull requests from the work item details page in Zoho Sprints using the Bitbucket integration. Availability: Premier and Professional plans Region: This feature is not available ...Zoho Desk integration
Do you want to follow an organized scrum way to manage your daily ticket details? It's now possible with our Zoho Desk integration. Just add the Zoho Sprints app in the Zoho Desk marketplace. Available plan: Premier and Professional. Available ...Zoho Meeting Integration
Conveying information effectively is one of the key reasons for a well-organized business. Personal interactions are the best way to pass on information. However, when circumstances make it impossible to have direct face-to-face meetings, virtual ...Zoho Projects Integration
No matter how many projects you have on your list or teams to coordinate - Managing everything in the right way matters the most. Project management methodologies are many, and every team is bound to follow a standard process. That's why moving to a ...