GitHub integration

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: Professional 
Region: This feature is not available in the CN region.
Access control:  Team Owner

Authorize Github account  

  1. Navigate to   in the upper-right corner.
  2. Select GitHub.
  3. Click Authorize.
 
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

  1. Navigate to  in the upper-right corner.
  2. Select  GitHub.
  3. View the list of repositories in your Personal Repository.  
  4. Hover over the repository name. 
  5. 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. 
  1. Navigate to  in the upper-right corner.
  2. Select  GitHub.
  3. View the list of repositories in your Team Repository.
  4. Click + next to  the repository.
  5. 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

  1. Navigate to work item details page. 
  2. Select  Github from the tabs.
  3. Click  Attach Commit.
  4. Select the required fields.  * All the fields are mandatory. 
  5. Click  Attach.

Attach pull requests from work item details section

  1. Navigate to work item details page. 
  2. Select  Github from the tabs.
  3. Click  Attach Pull Request.
  4. Select the required fields.  * All the fields are mandatory. 
  5. 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
  1. Navigate to  in the upper-right corner.
  2. Select  GitHub.
  3. Select + in the right corner of the mapped repository in your  Team Repository.  
  4. Deselect the projects in the  Associate Projects form.
  5. Click  Update. 
Directly from the Team Repository
  1. Navigate to  in the upper-right corner.
  2. Select  GitHub.
  3. Click on the count next to the team repository.
  4. Hover over the project that you want to dissociate.
  5. 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

  1. Navigate to  in the upper-right corner.
  2. Select  GitHub.
  3. View the list of repositories in your Team Repository.
  4. Hover over the repository name. 
  5. 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:
  1. Navigate to  in the upper-right corner.
  2. Select GitHub.
  3. Click    at the bottom-right corner of your personal repository. 
  4. 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.  

    • Related Articles

    • Github integration

      Github integration allows you to host your repositories, see source commits, and make code changes. And so, now you can view all the changes made in your Github repository in Zoho Projects. Feature Availability: Premium and Enterprise plans Copy ...

    • Can I integrate with Github and collaborate?

      Yes, you can integrate with Github and host your repositories, view source commits and make code changes. Learn More.

    • Bitbucket integration

      Having multiple lines of code and changing versions can be difficult to track. Commit codes in Bitbucket and view the changesets inside Zoho Projects. You can integrate Zoho BugTracker with Bitbucket using webhooks. You must be an Admin to integrate ...

    • Slack integration

      For effective team communication, we have integrated Slack into Zoho Projects. Now, you can push your project updates to Slack feeds and manage your project activities. Group your project activities and conversations together to keep the project ...

    • Gitea Integration

      Gitea integration allows you to host your repositories, see source commits, and make code changes. And so, now you can view all the changes made in your Gitea repository in Zoho Projects. You must copy the Webhook URL in Zoho Projects to map the ...