Jenkins Integration

Jenkins Integration

Software businesses across the globe is mostly automated. As the customer requirements pile up, the development and operations need to deliver outcomes in rapid phases. If you are an agile team, no wonder that your deliverables are quite frequent and you definitely need a Devops tool for an organized and timely deliverable. 

Available Plan: Professional and Zoho One

Why Jenkins integration for Zoho Sprints?

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 your to perform the following operations right while you work with different cases in your pipeline. 
  1. Directly add work items to your projects via Jenkins.
  2. Automatically update your work item's progress across the destined status and priority. 
  3. View the build logs for each work item on its details page. 
  4. Add comments to your work items or sprints directly from Jenkins. 
  5. Upload the build log file to the work items from Jenkins. 
  6. 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.  

Enable integration from Zoho Sprints

  1. Navigate to  Setup in the upper-right corner.
  2. Click  Jenkins from Integrations.
  3. Click  Enable Now . 

Configure Zoho Sprints team with Jenkins

  1. Navigate to your  Jenkins  account.
  2. Select  Manage Settings in the left panel.
  3. Click  Configure System .
  4. Navigate to  Sprints Connection .
  5. Enter the  Connection Name, Sprints Team URL, Sprints Team Admin Mail ID , and select  Sprints API Token (Sprints Client to connect) .
  6. Click  Add  and select  Jenkins .
  7. Select the  Kind as  Sprints API Token .
  8. Click  Generate Authentication Token in Zoho Sprints to generate the refresh token.
  9. Copy and paste the  Client ID, Client Secret, and Redirection URL  from Zoho Sprints.
  10. Click  Authenticate and  Migrate .

Note:  Click  Authenticate  and  Migrate t o configure and to migrate the existing builds from Jenkins to Zoho Sprints.    

Build actions in Jenkins   

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 Item Status .
    1. Prefix:  Enter the relevant project and item ID here.  Example: P1#I10 (P1 - Project number, I10 - Item number). If there are multiple items to be updated, you can specify them like: P1#I10, P#I11, P#I12, P2#I136. 
    2. Move to Status: You can enter the relevant status name.
  6. Save  and  Apply your changes.
  7. Click  Build Now  to trigger the API. 

Note:  You can change the status of the work items only in the active sprint.  

Update item priority

  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 Item Priority .
    1. Prefix:  Enter the relevant project and item ID here.  Example: P1#I10 (P1 - Project number, I10 - Item number). If there are multiple items to be updated, you can specify them like: P1#I10, P#I11, P#I12, P2#I13. 
    2. Move Priority To:  Enter the priority name as defined in Zoho Sprints. 
  6. Save and  Apply your changes.
  7. 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 feed status .
    1. Prefix:  Enter the project ID here.  Example: P7.  The status will be posted in the project's feed.
    2. Status:  Enter the content for your status in this section. Note: All the script related information will be automatically removed.
  6. Save and  Apply  your changes.
  7. Click  Build Now to trigger the API.

Add comments to item

You can add a comment to your sprint or 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 comments to item . 
    1. Prefix: Enter the relevant project ID along with the Item ID.  Example: P7#I10 .
    2. Add comment: Enter your comment for the item here. 
    3. Add attachment:  If you would like to attach the log files of your build, you can choose Yes, add. The build log file will be attached to the relevant item's comment. 
  6. Save and  Apply  your changes.
  7. Click Build Now to trigger the API.

Post build actions in Jenkins

Create new item   

You can create a new work item to your backlog or sprint in your Post Build from Jenkins. 
  1. Sign In to your  Jenkins  account.
  2. Navigate to the  Build .
  3. Click  Configure  from the left menu.
  4. Select  Add post-build action  under the  Post-build Actions .
  5. Choose  [Zoho Sprints] Create New Item .
    1. Prefix:  Enter the prefix.  Example: P8#S4 (P1 - Project ID, S2 - Sprint Number) or P8#S0 (P8 - Project ID, S0 - Backlog ID) .
    2. Item Name:  Input your work item name.
    3. Item Description:  Enter description for your work item.
    4. Assign Item To:  Enter the email address of the portal user here. Note: The user should be in an active status. If the user hasn't confirmed his email address or is inactive, then the user will not be added as an assignee.
    5. Item Type:  Choose Task or Bug. Note: You can only add the item types: Task or bug.
    6. Add Attachment:  Choose Add Log File to add the build log file as an attachment to your item.
  6. Save and  Apply  your changes.
  7. Click Build Now  to trigger the API.

You can perform the other actions like status and priority update, adding feed status and comment to work item in your post build actions.  

Create item on build failure

On build failure, you can automate and create a new work item. 
  1. Sign In to your  Jenkins  account.
  2. Navigate to the  Build .
  3. Click  Configure from the left menu.
  4. Select  Build Environment .
  5. Choose  [Zoho Sprints] Create Item on Failure .
    1. Prefix:  Enter the prefix.  Example: P8#S4 (P1 - Project ID, S2 - Sprint Number) or P8#S0 (P8 - Project ID, S0 - Backlog ID) . 
    2. Item Name:  Input your work item name.
    3. Item Description:  Enter description for your work item.
    4. Assign Item To:  Enter the email address of the portal user here. Note: The user should be in an active status. If the user has not confirmed his email address or is inactive, then the user will not be added as an assignee.
    5. Item Type:  Choose Task or Bug. Note: You can only add the item types: Task or bug. 
    6. Add Attachment:  Choose Add Log File to add the build log file as an attachment to your item.
  6. Save  and  Apply  your changes.
  7. Click  Build Now  to trigger the API. 
If you choose to upload the build log file, it gets reflected in the ' Attachments ' section in your work item. 


Build Details in Zoho Sprints

View build updates

You can track all the build updates made in Jenkins from your Zoho Sprints team. 
  1. Click the  Jenkins Icon  from the top panel.
  2. View all the  Build   updates  against each jobs.
  3. Click the  search icon next to  Job Name  to search for a relevant job. 
  4. Click  Customize Column and set visibility for the required fields. 
  5. Click the logs next to the  Last Success and  Last Failure columns to view the Logs, Actions, and Activity  of the build. 

Did you know?
 
Log:  All the build logs that are triggered in your Jenkins build.
Action:  Action tab contains the new work items created by the build.
Activity:  Activity contains the list of streams that are triggered in the build.  

View build details   

You can track your build details for individual jobs. 
  1. Click  View Details next to the relevant Job Name.
  2. Search for the Build Name.
  3. Click  View   Build Details  to view the  Logs, Actions, and Activity  of your build.
  4. Click  Customize Column and set visibility for the required fields. 
  

Filter build details

You can filter the build details anytime.
  1. Click the  Filter icon at the top right corner.
  2. Select the different criteria -  Build Duration, Waiting Time, Build On, Build Status, and Triggered By.  
  3. You can also search for the particular user who triggered the build by searching for the user name.
  4. Click  Apply Filter . 

Export build details   

You can also export your build details to XLS or CSV files. 
  1. Click the  Jenkins Icon  from the top panel.
  2. Click  View Details against the relevant  Job Name .
  3. Click the  Filter icon and select  Export  in the top right corner.
  4. Choose the  Format  of your export file and select the other criteria for your export.
  5. Click  Export .
Note: Click  Export History  to view all the past exports.  

Jenkins and Build Reports

You can view a detailed report on your build in Zoho Sprints. 
Types of reports: 
  1. Jenkins Reports:  Tracks the user and job based report.
  2. Build Reports:  Tracks the build by status and job.
 
Jenkins - User based report
 
Jenkins user based report will track the number of builds triggered by each user in a particular job.
  1. Navigate to  Jenkins in the top panel.
  2. Click  View Reports in the right corner.
  3. Select  User   Based   Reports  in  Jenkins Report .
  4. Hover over a particular user to view the relevant  Job Name ,  Count (No. of build triggered by the user) .
  5. Select  View By  in the right corner and choose your report from:  This Week, Last Week, Today, 1 Hour, 6 Hours, and 12 Hours . 
  6. Click  Export  next to  View By  to export your report.
Benefits:  
  1. Track the users who have triggered a maximum build in a particular job.
  2. Track the job that has taken a maximum build updates.
  3. Track the performance of all the users in your job.
  

Jenkins - Job based report
 
Jenkins job based report will track the number of builds triggered for each job based on the default build status:  Building, Success, Failure, Aborted.
  1. Navigate to Jenkins  in the top panel.
  2. Click View Reports  in the right corner.
  3. Select Job Based Reports in Jenkins Report.
  4. Hover over a particular job to view the count of builds and their status.
  5. Select View By in the right corner and choose your report from: This Week, Last Week, Today, 1 Hour, 6 Hours, and 12 Hours .
  6. Click Export next to View By to export your report. 
Benefits:
  1. Track the job that takes a maximum number of builds.
  2. Track the number of failed builds and schedule a scrum meeting to discuss the setbacks. 
  3. Track the build success on an average of 1 week and plan for future build updates.  
Build reports
 
Build reports help you track the count of builds in each status and the build count in each job. You can view the build reports by status and job. 
  1. Build report by status:  Track the number of builds in each status. 
  2. Build report by job:  Track the number of builds triggered for each job in Jenkins. 


    • Related Articles

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

    • Gitlab Integration

      Gitlab 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 Gitlab repository in Zoho Projects. You must copy the Webhook URL in Zoho Projects to map the ...

    • CRM Integration

      Enabling the integration with Zoho CRM will allow you to fetch Contacts, Accounts and Products details from CRM. To enable the CRM integration: Navigate to Setup > Integrations > Zoho CRM and click Enable. Select the Company Name of the CRM account ...