GitLab integration | Zoho Sprints Help

GitLab integration

Manage your GitLab repositories in Zoho Sprints. Map the repositories to relevant projects, attach commits, and merge requests in the work item details page.

Info
Access control: Workspace Owner Authorize GitLab account
  1. Click the gear icon in the top-right corner. The settings window will appear.
  2. Click Others under Marketplace.
  3. Click Configure on the GitLab app.
  4. Accept the terms.
  5. Select Cloud or Self-Managed.
  6. 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.

Configure your account from the Self-Managed version of GitLab

  1. Navigate to Settings in the upper-right corner in the self-managed version of GitLab.
  2. Navigate to Access Token in the left panel.
  3. Enable api and read_user scopes and create a new access token.
  4. 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 merge requests to a work item using quick commands or from the work item details page.

Map your repositories to workspace repository

  1. Click the gear icon in the top-right corner. The settings window will appear.
  2. Select Others under Marketplace.
  3. Select GitLab.

View the list of repositories in My Repository

  1. Hover over the repository name.
  2. 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.

  1. Go to GitLab.
  2. View the list of repositories in your Workspace Repository.
  3. Click the Associate Projects button. The projects listing will appear.
  4. 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.
  1. Go to GitLab.
  2. Map repositories to your workspace.
  3. Click the Associate Projects button. The project listing will appear.
  4. Select project.
  5. Click the toggle switch to enable Sync Only Bugs. (You can associate multiple projects to your repository. But, you can mark only one project to 'Sync Only Bugs'.)
  6. Click Update.
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.

Two-way sync for fields 

  1. Title
  2. Description
  3. Comments
  4. Weight (Estimation Points) 
  5. Start date
  6. End date
  7. Assignee
Notes
  1. Only the repositories with "Sync Only Bugs" enabled will be listed in the Create Item window.
  2. The estimation points that you define in Sprints will be synced to the nearest point in GitLab.
  3. 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 merge requests. Here are the supported commands.

Work item tagging is supported only through the merge request "Description" field.

Syntax 
Example 
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.

Notes
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
Example 
What happens? 
#workitemid,#workitemid,#workitemid #comment <message>
#SM-I25,#SM-I42,#SM-I98 #comment Issues are resolved and updated in the local build.
All the three work items are added with the comment.

Multiple commands for single work item

Syntax Example  What happens? 
#workitemid #comment <message> #priority <priority_name> #time < > h < > m #status <status_name> #SM-I34 #comment List out the requirements #priority High #time 5h 3m #status In_progress

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 Example  What happens? 
#workitemid,#workitemid,#workitemid #comment <message> #priority <priority_name> #time <>h <>m #status <status_name> #SM-I34, #SM-I45, #SM-I54 #comment List out the requirements #priority High #time 5h 3m #status In_progress

All the three work items are added with comments, log hours and updated with status and priority.


Merge Request: Auto close items with quick commands  

You can update work items directly from merge request using quick commands. In the description of the merge request, enter the quick command in the format #entity ID with prefix #status <actual status>. For example: '#SP-I1 #status done'.  (Know how to fetch the entity ID with prefix). This will associate the work item with the merge request and update the item's status to closed automatically when the request is merged, saving time, while keeping the development and work status in sync. Work items are updated consistently as a part of the merge request.
 
When the merge request is merged, the status commands are processed against the work item and the respective status is updated for the item. The user who initiates the merge request will be the user who performed the status update. This info will be captured in the audit log.
 
Notes
Note:
  1. Users will receive a feed notification for any status updates executed through Merge requests.
  2. Users can link new work items by editing the merge request's description.
  3. The linked items cannot be reverted through quick commands from the merge request description. Users can remove them from the merge request tab in item details page.  

Attach commits from work item details section

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

Attach merge requests from work item details section

  1. Go to the work item details page.
  2. Select GitLab from the tabs.
  3. Click Attach Merge Request.
  4. Enter the required details. * All the fields are mandatory.
  5. 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 with prefix? 

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 merge request comment.
  1. Navigate to a project.
  2. Select an item.
  3. On the Item details page, hover over the project name prefix.
  4. Select Copy ID with prefix

Delete commits and merge request

You can delete the commit and merge request directly from the work item details page. Hover over the attached commit and merge request and click .

Access for commands

Adding comments

  1. You must be an active user in the project to tag comments to work items in your commits.
  2. Anyone can add comments to the work items in the backlog.
  3. You must be a part of the sprint and have the work item assigned to you before you can add comments to it.
  4. You can also add comments for unassigned work items.

Adding Log hours

  1. You must be an active user in the project to add log hours to the work items.
  2. You can log hours for the work items only in active sprint.
  3. You must be a part of the sprint.
  4. You can only add log hours for unassigned work items and the work items that are assigned to you.

Updating priority

  1. When a priority contains space, add them in the quick command separated by '_'. For example: #SP-L1 #priority low_risk. Priorities are not case sensitive. 
  2. You must be an active user in the project to update the priority of the work items.
  3. You should be the admin, joint admin, or project manager to update the priority of the work items.
  4. The priority name that you provide must be an existing priority in the project.
  5. You can update the priority of the work items only for the active and upcoming sprints and the work items in the backlog.
  6. You cannot update the priority of the work items if they are in the closed status.

Updating status

  1. When a status contains space, add them in the quick command separated by '_'. For example: #SP-L1 #status to_do. Statuses are not case sensitive. 
  2. You must be an active user in the project to update the status of the work items.
  3. You can be a sprint owner, assignee, admin, manager, or sprint creator to update the status of the work items.
  4. The status name that you mention must be an existing status in the project.
  5. 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:
  1. Sign in to Zoho Sprints.
  2. Select the CI/CD option in the left navigation panel. The tabs for CI/CD will appear.
  3. Select GitLab tab.
  4. Select a mapped repository. The pipeline and commits in the repository will appear.
  5. Hover over pipeline to view details and stage.
  6. 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
  1. Go to GitLab.
  2. Click the Associate Project button in your Workspace Repository.
  3. Deselect the projects in the Associate Projects form.
  4. Click Update.
Directly from the Workspace Repository
  1. Go to GitLab.
  2. Click the project count next displayed.
  3. Hover over the project that you want to dissociate.
  4. Click Remove Project.

Remove repositories from team

  1. Go to GitLab.
  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 workspace.

What happens when the repository is removed from the workspace?

You can no longer attach commits and merge 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:
  1. Go to GitLab.
  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 GitLab settings and disable the webhook created for the respective workspace or my repository.





        Create. Review. Publish.

        Write, edit, collaborate on, and publish documents to different content management platforms.

        Get Started Now


          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 CRM Training
              Redefine the way you work
              with Zoho Workplace

                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 CRM Training

                  Create, share, and deliver

                  beautiful slides from anywhere.

                  Get Started Now


                    Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                    BOOK A SESSION







                                Quick LinksWorkflow AutomationData Collection
                                Web FormsEnterpriseOnline Data Collection Tool
                                Embeddable FormsBankingBegin Data Collection
                                Interactive FormsWorkplaceData Collection App
                                CRM FormsCustomer ServiceAccessible Forms
                                Digital FormsMarketingForms for Small Business
                                HTML FormsEducationForms for Enterprise
                                Contact FormsE-commerceForms for any business
                                Lead Generation FormsHealthcareForms for Startups
                                Wordpress FormsCustomer onboardingForms for Small Business
                                No Code FormsConstructionRSVP tool for holidays
                                Free FormsTravelFeatures for Order Forms
                                Prefill FormsNon-Profit

                                Intake FormsLegal
                                Mobile App
                                Form DesignerHR
                                Mobile Forms
                                Card FormsFoodOffline Forms
                                Assign FormsPhotographyMobile Forms Features
                                Translate FormsReal EstateKiosk in Mobile Forms
                                Electronic Forms
                                Drag & drop form builder

                                Notification Emails for FormsAlternativesSecurity & Compliance
                                Holiday FormsGoogle Forms alternative GDPR
                                Form to PDFJotform alternativeHIPAA Forms
                                Email FormsFormstack alternativeEncrypted Forms

                                Wufoo alternativeSecure Forms

                                TypeformWCAG


                                      All-in-one knowledge management and training platform for your employees and customers.

                                                Create. Review. Publish.

                                                Write, edit, collaborate on, and publish documents to different content management platforms.

                                                Get Started Now




                                                                  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.




                                                                      Manage your brands on social media


                                                                        • Desk Community Learning Series


                                                                        • Digest


                                                                        • Functions


                                                                        • Meetups


                                                                        • Kbase


                                                                        • Resources


                                                                        • Glossary


                                                                        • Desk Marketplace


                                                                        • MVP Corner


                                                                        • Word of the Day


                                                                        • Ask the Experts


                                                                          Zoho Sheet Resources

                                                                           

                                                                              Zoho Forms Resources


                                                                                Secure your business
                                                                                communication with Zoho Mail


                                                                                Mail on the move with
                                                                                Zoho Mail mobile application

                                                                                  Stay on top of your schedule
                                                                                  at all times


                                                                                  Carry your calendar with you
                                                                                  Anytime, anywhere




                                                                                        Zoho Sign Resources

                                                                                          Sign, Paperless!

                                                                                          Sign and send business documents on the go!

                                                                                          Get Started Now




                                                                                                  Zoho TeamInbox Resources





                                                                                                            Zoho DataPrep Demo

                                                                                                            Get a personalized demo or POC

                                                                                                            REGISTER NOW


                                                                                                              Design. Discuss. Deliver.

                                                                                                              Create visually engaging stories with Zoho Show.

                                                                                                              Get Started Now








                                                                                                                                  • Related Articles

                                                                                                                                  • Zoho Sprints Extension for Google Marketplace

                                                                                                                                    Zoho Sprints extension provides a simple solution to manage your work items from your Gmail inbox. Convert your emails into work items with the help of this widget. You can view and edit the contents of the item right there or quickly navigate to ...
                                                                                                                                  • 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 ...
                                                                                                                                  • Zoho BugTracker integration

                                                                                                                                    Bugs in software development should be fixed as soon as possible. It is easier to track and fix bugs when they are compiled and listed separately. Integrate your Zoho Sprints account with Zoho BugTracker to track and manage your bugs. This is ...
                                                                                                                                  • 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. Availability: Premier, Enterprise and Zoho One plan Add ...
                                                                                                                                  • Zoho Projects integration

                                                                                                                                    No matter how many projects you have on your list to coordinate, managing everything in the right way matters the most. Project management methodologies are many, and every business is bound to follow a standard process. That's why moving to a ...
                                                                                                                                    Wherever you are is as good as
                                                                                                                                    your workplace

                                                                                                                                      Resources

                                                                                                                                      Videos

                                                                                                                                      Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                                      eBooks

                                                                                                                                      Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                                      Webinars

                                                                                                                                      Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                                      CRM Tips

                                                                                                                                      Make the most of Zoho CRM with these useful tips.



                                                                                                                                        Zoho Show Resources