Jenkins integration | Zoho Sprints Help

Jenkins integration

DevOps tools are built to facilitate collaboration, leverage automation, and enhance the ability to track and monitor process and progress. As the customer requirements pile up, the development and operations need to deliver outcomes in rapid phases. In particular, it is highly recommended for agile teams to adopt DevOps tool to organize their work and deliver on time.
Jenkins is a well-approved tool that can interact with Zoho Sprints in a secure manner and provide all the necessary support for your development teams.

Benefits of Jenkins integration

When it comes to CI/CD (continuous integration/continuous deployment), Jenkins is the top-notch automation tool that befriends developers and makes the build updates clutter-free. Implementing your agile team's work through a steady integration with Jenkins helps perform the following operations right while you work with different cases in your pipeline.
  1. Add work items, sprints, and releases without navigating to Zoho Sprints.
  2. Update work items, sprints, and releases.
  3. Start and complete sprints directly via Jenkins.
  4. Add the item, sprint, and release comments directly from Jenkins.
  5. Add feed status for every build update from Jenkins.
 
Your development related work items can be run directly from Jenkins and you can track them in Zoho Sprints.

Note: Users must install the latest version of Zoho Sprints plugin to enable Jenkins integration. Those with the previous version must update to the new version to continue using the integration.

Install Sprints-Jenkins Plugin

  1. Install the latest Sprints plugin for your Jenkins instance.
  2. Restart the Jenkins instance following installation.
    NotePortal Owner Auth details will be shared automatically when the Configure Jenkins from Zoho Sprints process is done.

 

Configure from Zoho Sprints

  1. Click the settings icon in the top-right corner. The Settings page will appear.
  2. Select to Others under Marketplace. The apps for integration will appear.

  3. Go to Jenkins app.
  4. Agree to the terms and conditions.
  5. Click the Enable Now button.

  6. Enter Jenkins Host URL.
  7. Enter your User ID.
  8. Enter your API Token. Refer the section below.

  9. Click the Add Configuration button. The configuration will be complete.

  10. Click the Configure button to proceed to authorize Zoho Sprints to access Jenkins.
  11. Click the Accept button to complete integration.
To generate API Token
  1. Login to Jenkins.
  2. Select the Profile menu in the top section.

  3. Click the Configure in the dropdown.
  4. In the API token section, click the Add New Token button.

  5. Provide a name for the token.
  6. Click the Generate button.

  7. Copy the generated token since it will be shown only at the time of the creation.
 

View Build Details in Zoho Sprints

You can track all the build updates made in Jenkins from your Zoho Sprints team.
  1. Sign in to Zoho Sprints.
  2. Select the CI/CD option on the left navigation panel.
  3. Select Jenkins. All the build related logs are listed.

  4. Hover and click the View Details link to navigate to the build details. The build names and details are available.

  5. Hover and click the View log link to navigate to Jenkins and view the log.
    Note: Click the Job name dropdown to select jobs.
Build stability percentage and the build status information are available.

Item fields in Jenkins

The following fields will be available for you while you create items from your Jenkins account:
  1. Project Number: Enter the project number. Example: 14. Obtain number from project #P14.
  2. Sprint Number: Enter the sprint number. Example: 7. Obtain number from sprint SP7.
  3. Item Number:  Enter the item number. Example: 9. Obtain number from item I9.
  4. Item Name: Enter the name of the item as in the Item title.
  5. Description: Describe the item.
  6. Assignees: Provide the email addresses of the item users (separated by commas)
  7. Type: Enter item type. Example: Task, Bug, or Story.
  8. Status: Specify item status. Example: To do.
  9. Priority: Specify priority level. Example: High.
  10. Start Date: Specify the item start date. Example: 2022-08-13T00:00:00Z
  11. End Date: Specify the item end date. Example: 2022-08-13T00:00:00Z
  12. Duration: Mention a tentative duration of the sprint. A sprint duration cannot exceed 8 weeks when strict scrum is enabled. And if strict scrum is disabled, it can last up to 30 weeks. Example: 2hrs 50min
  13. Custom Fields: Specify the custom field values here. If there are multiple custom fields, they should be mentioned in a new line.
    Example:
            Custom Field input:
            UDF1_BOOLEAN=123456
            UDF1_TEXT=text value

Sprint fields in Jenkins

The following fields will be available for you while you create sprints from your Jenkins account:

  1. Project Number: Enter the project number. Example: 14. Obtain number from project #P14.
  2. Sprint Number: Enter the sprint number. Example: 7. Obtain number from sprint SP7.
  3. Sprint Name: Name of the sprint as in the sprint title.
  4. Description: Describe the sprint.
  5. Scrum Master: Mention the email address of the scrum master
  6. Sprint Users: Provide the email addresses of the sprint users (separated by commas)
  7. Start Date: Specify the sprint start date. Example: 2022-08-13T00:00:00Z
  8. End Date: Specify the sprint end date. Example: 2022-08-13T00:00:00Z
  9. Duration: Mention a tentative duration of the sprint. A sprint duration cannot exceed 8 weeks when strict scrum is enabled. And if strict scrum is disabled, it can last up to 30 weeks. Example: 2hrs 50min
  10. Custom Fields: Specify the custom field values here. If there are multiple custom fields, they should be mentioned in a new line.
    Example:
    UDF1_BOOLEAN=12345
    UDF1_TEXT=text value

 Release fields in Jenkins

The following fields will be available for you while you create releases from your Jenkins account:
  1. Project Number: Enter the project number. Example: 14. Obtain number from project #P14.
  2. Release Name: Provide a name to the release. Example: 1. Obtain number from release R1.
  3. Release Goal: Describe the purpose of the release.
  4. Start Date: Enter the starting date of the release. Example: 2022-08-13T00:00:00Z
  5. Release Date: Enter the release date. Example: 2022-10-13T00:00:00Z
  6. Owners: Mention the email address of the owner separated by commas
  7. Release Stage: Specify the stage in which the release is currently in. Example: Planning
  8. Custom Fields: Specify the custom field values here. If there are multiple custom fields, they should be mentioned in a new line.
    1. Example:
      UDF1_BOOLEAN=12345
      UDF1_TEXT=text value

 

Build actions in Jenkins   

The build actions supported in Jenkins include:
  1. Create work item
  2. Create sprint
  3. Create release
  4. Update item
  5. Update sprint
  6. Update release
  7. Start sprint
  8. Complete sprint
  9. Add item, release, and sprint comment
  10. Add feed status
  11. Create item on build failure

Create item from Jenkins

To add a work item from Jenkins:
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step  under the Build section.

  5. Click [Zoho Sprints] Create a work item. The item fields will appear.
  6. Enter the item details. Refer here.
  7. Save and Apply your changes.

  8. Click Build Now to trigger the API.

 

Create sprint from Jenkins

To create sprint from Jenkins:
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step  under the Build section.
  5. Click [Zoho Sprints] Create a sprint. The sprint fields will appear.
  6. Enter the sprint details. Refer here.
  7. Save and Apply your changes.
  8. Click Build Now to trigger the API.

Create release from Jenkins

To create release from Jenkins:
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build section.
  5. Click [Zoho Sprints] Create a release. The release fields will appear.
  6. Enter the release details. Refer here.
  7. Save and Apply your changes.
  8. Click Build Now to trigger the API.

Update item from Jenkins

To update item status from Jenkins:
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build section.
  5. Click [Zoho Sprints] Update a work item. The item fields will appear.
  6. Enter the relevant project, sprint, and item numbers. Refer here.
  7. Enter the relevant changes. For example, change status or priority.
  8. Save and Apply your changes.
  9. Click Build Now to trigger the API.


Update sprint from Jenkins

To update item status from Jenkins:
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build section.
  5. Click [Zoho Sprints] Update a sprint. The sprint fields will appear.
  6. Enter the relevant project and sprint numbers. Refer here.
  7. Enter the relevant changes. For example, start and end dates or the sprint.
  8. Save and Apply your changes.
  9. Click Build Now to trigger the API.
 

Add feed status

You can directly add a status on your project feed right from Jenkins.
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build  section.
  5. Click [Zoho Sprints] Add a feed status.
  6. Enter the relevant project number.
  7. Enter the content for your status in status section. Note: All the script related information will be automatically removed.

  8. Save and Apply your changes.
  9. Click Build Now to trigger the API.

 

Add comments to item

You can add a comment to your work item from Jenkins.
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build  section.
  5. Click [Zoho Sprints] Add an item comment.
  6. Enter the relevant project, sprint, and item numbers.
  7. Enter the comment.

  8. Save and Apply your changes.
  9. Click Build Now to trigger the API.
 

Add comments to release

You can add a comment to your release from Jenkins.
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build  section.
  5. Click [Zoho Sprints] Add a release comment.
  6. Enter the relevant project and release numbers.
  7. Enter the comment.
  8. Save and Apply your changes.
  9. Click Build Now to trigger the API.
 

Add comments to sprint

You can add a comment to your sprint from Jenkins.
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build  section.
  5. Click [Zoho Sprints] Add a sprint comment. The sprint fields will appear.
  6. Enter the relevant project and sprint numbers.
  7. Enter the comment.
  8. Save and Apply your changes.
  9. Click Build Now to trigger the API.

 

Update a release

To update release:
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build section.
  5. Click [Zoho Sprints] Update a release. The release fields will appear.
  6. Enter the relevant project and release numbers.
  7. Enter the stage to which you'd like to update the release. Refer here.
  8. Save and Apply your changes.
  9. Click Build Now to trigger the API.

Start a sprint

To start a sprint from Jenkins
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build section.
  5. Click [Zoho Sprints] Start a sprint.
  6. Enter the relevant project and sprint numbers.
  7. Save and Apply your changes.
  8. Click Build Now to trigger the API.
 

Complete a sprint

To complete a sprint from Jenkins
  1. Sign in to your Jenkins account.
  2. Navigate to the Build.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build section.
  5. Click [Zoho Sprints] Complete a sprint.
  6. Enter the relevant project and sprint numbers.
  7. Save and Apply your changes.
  8. Click Build Now to trigger the API.

Post build actions in Jenkins

You can perform all the above mentioned actions as Post Build actions from your Jenkins account. Additionally, you can create a new item at the event of build failure.

  


    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









                                      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

                                            Zoho Desk Resources

                                            • Desk Community Learning Series


                                            • Digest


                                            • Functions


                                            • Meetups


                                            • Kbase


                                            • Resources


                                            • Glossary


                                            • Desk Marketplace


                                            • MVP Corner


                                            • Word of the Day


                                              Zoho Marketing Automation

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

                                                                                                        • 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. Access control: Team Owner Authorize Bitbucket account Click the gear icon in the ...
                                                                                                        • GitHub integration

                                                                                                          Track your code changes and improve and revise them using the developer-friendly platform: GitHub. Integrate your Zoho Sprints workspace with GitHub and manage repositories. Access control: Workspace Owner Authorize Github account Click the gear icon ...
                                                                                                        • 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 ...
                                                                                                        • 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 ...
                                                                                                        • Microsoft Office 365 integration

                                                                                                          Integrate your Zoho Sprints workspace with your Microsoft Office 365 account and get your work items mapped to Office 365 tasks and calendar. You can also map the meetings to your Office calendar and never miss any meet ups. Access privileges: ...
                                                                                                          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