Zoho Sprints

ID: zohosprints

zohosprints-jenkins-plugin

Build Status Jenkins Plugin Installs GitHub release

Description

Integrating Jenkins with Zoho Sprints saves your time and effort by working with just one at a time. You can create the required actions in Zoho Sprints right while you update your build in Jenkins. You can also track all your build details and view the build performance report in Zoho Sprints.

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 Project.
  3. Click Configure from the left menu.
  4. Select Add build step under the Build section.
  5. Click [Zoho Sprints] Update Item Status.
    • 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.
    • Move to Status: You can enter the relevant status name.
  6. Save and Apply your changes.

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

Update item priority

  1. Navigate to the Project.
  2. Click Configure from the left menu.
  3. Select Add build step under the Build section.
  4. Click [Zoho Sprints] Update Item Priority.
    • 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.
    • Move Priority To: Enter the priority name as defined in Zoho Sprints.
  5. Save and Apply your changes.

Add feed status

You can directly add a status on your project feed right from Jenkins.

  1. Navigate to the Project.
  2. Click Configure from the left menu.
  3. Select Add build step under the Build section.
  4. Click [Zoho Sprints] Add feed status.
    • Prefix: Enter the project ID here. Example: P7. The status will be posted in the project's feed.
    • Status: Enter the content for your status in this section. Note: All the script related information will be automatically removed.
  5. Save and Apply your changes.

Add comments to item

You can add a comment to your sprint or work item from Jenkins.

  1. Navigate to the Project.
  2. Click Configure from the left menu.
  3. Select Add build step under the Build section.
  4. Click [Zoho Sprints] Add comments to item.
    • Prefix: Enter the relevant project ID along with the Item ID. Example: P7#I10.
    • Add comment: Enter your comment for the item here.
    • 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.
  5. Save and Apply your changes.

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.
    • Project Prefix: Enter the relevant project number here. Example: P1(P1 - Project number).
    • Item Prefix: Enter the prefix of the items that will be associated to the release.
    • Description: Add a description to your release.
    • Stage: Choose the stage of the release.
    • Release Owner: Enter the email address of the release owner.
    • 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.

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.
    • Prefix: Enter the relevant project and release ID here. Example: P1#R10 (P1 - Project number, R10 - Release number).
    • Stage: 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.
    • 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.
    • 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

Post build actions in Jenkins

You can perform the other actions like status and priority update, adding feed status, adding new release, release stage update, associate itemsto release and comment to work item in your post build actions

Create new item

You can create a new work item to your backlog or sprint in your Post Build from Jenkins.

  1. Navigate to the Project.
  2. Click Configure from the left menu.
  3. Select Add post-build action under the Post-build Actions.
  4. Choose [Zoho Sprints] Create New Item.
    • Prefix: Enter the prefix. Example: PI#S2#R1 (P1 - Project Number, S2 - Sprint Number/Backlog ID, R1 - Release Number). Release Number is Optional.
    • Item Name: Input your work item name.
    • Item Description: Enter description for your work item.
    • 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.
    • Item Type: Choose Task or Bug. Note: You can only add the item types: Task or bug.
    • Add Attachment: Choose Add Log File to add the build log file as an attachment to your item.
  5. Save and Apply your changes.

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. Navigate to the Project.
  2. Click Configure from the left menu.
  3. Select Build Environment.
  4. Choose [Zoho Sprints] Create Item on Failure.
    • Prefix: Enter the prefix. Example: PI#S2#R1 (P1 - Project Number, S2 - Sprint Number/Backlog ID, R1 - Release Number). Release Number is Optional.
    • Item Name: Input your work item name.
    • Item Description: Enter description for your work item.
    • 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.
    • Item Type: Choose Task or Bug. Note: You can only add the item types: Task or bug.
    • Add Attachment: Choose Add Log File to add the build log file as an attachment to your item.
  5. Save and Apply your changes.

This action will not work for Matrix projects.

ArchivesGet past versions
Version: 1.1.3
Released:
Requires Jenkins 2.7.3
Installs: 7
Labels
This plugin has no labels
Maintainers
Zoho Sprints
Help us improve this page!
To propose a change submit a pull request to the plugin page on GitHub.