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.
Access control: Workspace Owner
Authorize GitLab account
- Click the gear icon in the top-right corner. The settings window will appear.
- Click Others under Marketplace.
- Click configure on the GitLab app.
- Accept the terms
- Select Cloud or Self-Managed.
- On click of Cloud, you will be redirected to GitLab.com.
If you click Self-Managed,
- Copy and paste the URL and A ccess Token from your self-managed version and click Configure.
How to configure your account from the Self-Managed version of GitLab?
- Navigate to Settings in the upper-right corner in the self-managed version of GitLab.
- Navigate to Access Token in the left panel.
- Enable api and read_user scopes and create a new access token.
- Copy and paste the Access Token from GitLab to Zoho Sprints.
- My Repository: Personal repository lists all the repositories with admin access in GitLab.
- 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 commit and pull requests to a work item using quick commands or from the work item details page.
Map your repositories to workspace repository
- Click the gear icon in the top-right corner. The settings window will appear.
- Select Others under Marketplace.
- Select GitLab.
- View the list of repositories in My Repository.
- Hover over the repository name.
- Click the arrow icon next to the repository name to map the repository to your workspace.
Associate projects to workspace repository
You can associate a project to your workspace repository.
- Go to GitLab.
- View the list of repositories in your Workspace Repository.
- Click Associate Projects button. The projects listing will appear.
- Select the projects and click Update.
You can associate only 50 projects to a workspace repository.
Sync repository issues to projects
While mapping 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.
- Go to GitLab.
- Map repositories to your workspace.
- Click the Associate Projects button. The project listing will appear.
- Select project.
- Click the toggle switch to enable Sync Only Bugs.
- Click Update.
- You can view the issue in the item details page on clicking the GitLab icon.
- You can also access the link to GitLab directly from the work item details page.
Note: You can associate multiple projects to your repository. But, you can mark only one project to 'Sync Only Bugs'.
Fields Synced from GitLab
Title, Description, Status, Comments, Weight (Estimation Points)
Note:
- The estimation points that you define in GitLab will be synced to the nearest point in Zoho Sprints.
- Since we sync only the bugs to the marked project, all the work items are created in the default work item type 'BUG'.
- Status of the work items will be mapped to the open and closed status in Zoho Sprints.
Sync work items to GitLab repository
You will be able to simultaneously create data in GitLab while creating a work item in Sprints. The item creation screen includes the ability to add that particular work item to your GitLab account. The data is thus synced and the interaction is facilitated from and to Sprints.
Fields Synced from Sprints
Title, Description, Comments, and Weight (Estimation Points)
Note:
- Only the repositories with "Sync Only Bugs" enabled will be listed in the Create Item window.
- The estimation points that you define in Sprints will be synced to the nearest point in GitLab.
- Status of the work items will be mapped to the open and closed status in GitLab.
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.
Work item tagging is supported only through the pull request "Description" field.
| 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. | Add 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. | Update 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. | Update the priority of the work item. |
| #time | #workitemid #time <hours>h <minutes>m Example: #SP-I52 #time 5h 30m | Add log hours for the work item. |
- The email address of the GitLab 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 #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
- Go to the work item details page.
- Select GitLab from the tabs.
- Click Attach Commit.
- Enter the required details. * All the fields are mandatory.
- Click Attach.
Attach pull requests from work item details section
- Go to the work item details page.
- Select GitLab from the tabs.
- Click Attach Pull Request.
- Enter the required details. * All the fields are mandatory.
- Click Attach.
When you attach a commit via GitLab 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 user in the project to tag comments to work items in your commits.
- Anyone can add comments to the work items in the backlog.
- 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 only add 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.
- You should be the admin, joint admin, or project manager 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 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.
- You can be a sprint owner, assignee, admin, manager, or sprint creator 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.
CI/CD
There is a CI/CD option for GitLab. This will be available only for the mapped repositories. All your build updates will be available here. You can view the pipeline, branches, its stages and jobs.
To access GitLab in CI/CD:
- Sign in to Zoho Sprints.
- Select the CI/CD option in the left navigation panel. The tabs for CI/CD will appear.
- Select GitLab tab.
- Select a mapped repository. The pipeline and commits in the repository will appear.
- Hover over pipeline to view details and stage.
- Click the links to view the respective details.
You would also be able to view the mapped work item when you click a particular commit.
Disassociate projects from repository
You can also disassociate projects from the repository in two different ways.
From the associate project form
- Go to GitLab.
- Click the Associate Project button in your Workspace Repository.
- Deselect the projects in the Associate Projects form.
- Click Update.
Directly from the Workspace Repository
- Go to GitLab.
- Click the project count next displayed.
- Hover over the project that you want to dissociate.
- Click Remove Project.
Remove repositories from team
- Go to GitLab.
- View the list of repositories in your Workspace Repository.
- Hover over the repository name.
- Click the arrow icon to the left end of the repository name to unmap the repository from the workspace.
What happens when the repository is removed from the workspace?
You can no longer attach commits and pull requests to the work items either via GitLab or directly from the work item details page.
Remove GitLab authorization
You can remove the Gitlab account anytime from Zoho Sprints. To do this:
- Go to GitLab.
- Click
- 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 GitLab settings and disable the webhook created for the respective workspace or my repository.
Security related FAQs
How to ensure that Sprints users only have access to GitLab information through Sprints if they already possess access to that particular mapped GitLab repository?
Each user in Zoho Sprints must use their own GitLab authorization credentials to access GitLab. If the user does not have the necessary access privileges in the GitLab repository, they will not be able to access it from Zoho Sprints.
Which GitLab Account should be used to integrate with Sprints?
Zoho Sprints uses the OAuth 2.0 protocol to communicate with GitLab which mandates individual authorization. So, each user is required to integrate with their own GitLab account to facilitate the sync between Zoho Sprints workspace and GitLab.
Who has the permission to map repositories, projects, and issues to Sprints?
- Map repositories and projects: Zoho Sprints workspace owner reserves that permission to map repositories and projects.
- Map issues: Any Zoho Sprints user with the required permissions to create a work item in Zoho Sprints and to create an issue in GitLab can sync or map an issue between the two applications. Furthermore, to access the issue details within Zoho Sprints, they must also have the necessary permissions to view the issue in the GitLab repository.
Where can I track what information is revealed to which user?
- Work item details (under Gitlab tab) - Linked commits and merge requests will be available
- Work item details (right navigation bar) - Synced GitLab issues will be available
- Release module - All the commits and merge requests associated with a release will be available
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
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 CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
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 Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Data Encryption in Zoho Sprints
Encryption is primarily used to safeguard the content of a message so that only the intended recipients can read it. This is done by replacing the content with unrecognizable data, which can be understood only by the intended recipient. Encryption ...Zoho Sprints Data Deletion Process
Delete Sprints Workspace You can delete your Zoho Sprints workspace. When you delete the Sprints workspace, PII data will be deleted immediately and the team will be scheduled for the data cleanup process and it cannot be recovered. Inactive ...Zoho Sprints HIPAA Compliance Guide
The Health Insurance Portability and Accountability Act (including the Privacy Rule, Security Rule, Breach notification Rule, and Health Information Technology for Economic and Clinical Health Act) ("HIPAA"), requires Covered Entities and Business ...Zoho Sprints GDPR Compliance
Data privacy and security are the core elements that every business should guarantee its customers with. Keeping this in mind, the European Union's General Data Protection Regulation (GDPR) came into discussion. It enforces all the businesses across ...Zoho Analytics integration
One can oversee the course of a business and forecast its future with a wide range of detailed reports. Besides the inbuilt reports, you can now generate customized reports by integrating Zoho Sprints account with Zoho Analytics. Enable the ...
New to Zoho LandingPage?
Zoho LandingPage Resources