Access control:  Workspace Owner

Authorize Github account  

1. Click the gear icon in the top-right corner. The settings window will appear.
   
2. Select Others under Marketplace.
   
3. Click Configure on the GitHub app.
   
4. Accept the terms and then click Authorize.
   

My Repository: My repository lists all the repositories created in your GitHub account.

Workspace Repository: Workspace repository lists all the repositories that are mapped from your personal repository. Once mapped, these repositories can be associated to the projects.  Once associated, workspace members can add or attach commits and pull requests to a work item using quick commands or from the work item details page. 

Map my repositories to workspace repository

1. Click the gear icon in the top-right corner.
   
2. Select Others under Marketplace
   
3. Select GitHub.
   
4. View the list of repositories in My Repository.  
   
5. Hover over the repository name. 
   
6. Click the arrow icon next to the repository name to map the repository to your workspace. 

Associate projects to workspace repository  

1. Go GitHub.
2. View the list of repositories in your Workspace Repository .
   
3. Click Associate Projects button.
   
4. Select the projects.
   
5. Click Update.
   

You can associate only 50 projects to a workspace repository. 

Sync repository issues to projects 

While associating your projects to the repository, you can mark it as an 'Issue Project'. This will automatically sync all the upcoming issues that are added in your repository.

1. Go GitHub.
2. Click the Associate Project button.
   
3. Select projects.
   
4. Click the toggle switch to enable Sync only bugs
5. Click Update.

You can associate multiple projects to your repository. But, you can mark only one project to 'Sync Only Bugs'.

1. You can access the link to GitHub directly from the work item details page.
   
2. Click the GitHub icon to view the issue details and click View in GitHub to navigate to GitHub.
   

Fields Synced from GitHub

Title, Description, and Tags

 

Note:

1. Since we sync only the bugs to the marked project, all the work items are created in the default work item type 'BUG'.   
   

1. Status of the work items will be mapped to the open and closed status in Zoho Sprints. 

Sync work items to GitHub from Sprints

Fields Synced from Sprints

Title, Description, and Tags

Note:

Quick Commands in Zoho Sprints   

Only work item tagging is supported in the pull request comment.

• 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    

Attach commits from work item details section

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

Attach pull requests from work item details section

1. Go to the work item details page. 
   
2. Select Github from the tabs.
   
3. Click Attach Pull Request.
   
4. Enter the required details.  * 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.

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

1. Go GitHub and to the Workspace Repository section.
   
2. Click the Associate Project button. The projects will be listed.
   
3. Deselect the projects in the Associate Projects form.
   
4. Click Update. 
   

1. Go to GitHub and to the Workspace Repository.
2. Click the count next to the repository.
   
3. Hover over the project that you want to dissociate.
   
4. 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 workspace

1. Go GitHub.
2. View the list of repositories in your Workspace Repository.
   
3. Hover over the repository name. 
   
4. Click the arrow 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

1. Go GitHub.
2. Click    at the bottom of My Repository. A confirmation pop-up will appear.
   
3. Click Delete.
   

What happens when the authorization is removed?  

Once the repository is mapped to Workspace 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 workspace.