Available Plan: Starter, Elite, Premier 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.
   

Enable integration from Zoho Sprints

1. Navigate to Setup in the upper-right corner.
   
2. Navigate to Marketplace > Others.
   
3. Hover over Jenkins app and click Configure.
   
4. Accept the Terms & Conditions and then 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 to 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

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

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.
   

Update Release Stage 

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 Release Stage. 
   
1. Prefix: Enter the relevant project and release ID here.  Example: P1#R10 (P1 - Project number, R10 - Release number). 
   
2. Enter the stage to which you'd like to update the release.
   
6. Save and Apply your changes.
   
7. Click Build Now to trigger the API.
   

Associate Items to 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] Associate Item(s) to Release.
   
1. Prefix: Enter the relevant project and release ID here.  Example: P1#R10 (P1 - Project number, R10 - Release number). Multiple Items can be mapped to a single release.
   
2. Item to Map: Enter the prefix of your Item ID to map. 
   
6. Save and Apply your changes.
   
7. Click Build Now to trigger the API.

Note: A maximum of 15 items can be mapped.  

Add New 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] Add New Release.
   
1. Project Prefix: Enter the relevant project number here.  Example: P1(P1 - Project number).
   
2. Item Prefix: Enter the prefix of the items that will be associated to the release.
   
3. Description: Add a description to your release.
   
4. Stage: Choose the stage of the release.
   
5. Release Owner: Enter the email address of the release owner.
   
6. Release Time (In Days): Enter the number of days required for the release. 
   
6. Save and Apply your changes.
   
7. Click Build Now to trigger the API.

Note:

1. The stage should not be 'completed'.
   
2. Release Time should be a minimum of three days.

Release Details 

This page displays the name of the job and the build along with the name of the person who initiated it and the time, the name of the branch, the status of the build,  and the total duration. You can also view the build details. It also displays the total number of work items involved. You can even add new work items here.

Post build actions in Jenkins

Create new item   

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

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

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. 
   

View build details   

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

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   

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

Types of reports: 

1. Jenkins Reports: Tracks the user and job based report.
   
2. Build Reports: Tracks the build by status and 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.
   

 

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.  
   

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.