Compatibility with JIRA 7

ScriptRunner releases 4.2.x and above are compatible with JIRA 7, not below.

Your scripts will fail if you upgrade without modifications.

You will need to make some changes to your scripts to make them work with JIRA 7’s API. There is a guide to the major areas of change below.

Use this guide in conjunction with Preparing for JIRA 7, and specifically the API changes. This guide is focused on the areas of change likely to affect script writers.

Use the script registry to quickly review all your code.

Upgrades and staging Environments

If you do not have a staging environment you should invest the time it takes to create one. You should be able to reliably clone your production instance to the staging environment, so you can test plugins and upgrades.

A good strategy to follow is to

  • make changes now to remove all deprecated code, while you are using JIRA 6.3 or 6.4. Deprecations are shown with a yellow warning. If you do that your code has the best chance of working unchanged with JIRA 7.

    type checked condition depr
  • once the deprecated code has been fixed, upgrade your staging instance to JIRA 7

  • use the script registry to make sure you don’t have any type checking errors, and test

  • if you need to make changes, record what they are

  • when you upgrade your production instance, if you are using inline scripts, you will need to make the same changes. For files, you can update your scripts directory, e.g. by merging from a branch

Removal of ComponentManager methods

ComponentManager methods have been removed. Typically these have been used to get at JIRA managers and services, even though they have been deprecated for several years.

Where previously you used any of these constructs:

import com.atlassian.jira.ComponentManager
import com.atlassian.jira.bc.project.ProjectService

def commentManager = ComponentManager.instance.commentManager
// or
def commentManager = ComponentManager.getInstance().getCommentManager()
// or
def commentManager = ComponentManager.getCommentManager()

// getting some other type of service
def projectService = ComponentManager.getInstance().getComponentInstanceOfType(ProjectService)

now you should use:

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.bc.project.ProjectService

def commentManager = ComponentAccessor.commentManager

def projectService = ComponentAccessor.getComponent(ProjectService)

User replaced with ApplicationUser

Most methods that took or return a User have been replaced with a ApplicationUser.

You will notice this if you have statically typed a User, example:

get logged in user

In this case the solution is to use dynamic typing (and remove the redundant import):

import com.atlassian.jira.component.ComponentAccessor

def authContext = ComponentAccessor.jiraAuthenticationContext
def user = authContext.getLoggedInUser()

The method that you pass the user object to will also have been changed to use an ApplicationUser. In future, refrain from static typing objects (except for fields).

GenericValues removed

All methods that returned a GenericValue have been removed.

Previously, issue.priority would have returned a GenericValue, and you should have been using issue.priorityObject.

In JIRA 7, issue.priority returns a Priority object, and getPriorityObject() has been deprecated.

So if you have done nothing since JIRA 4, your code may now be perfectly correct. If you have have attempted to keep up with the deprecations, you should now revert back to getPriority().

An exception would be if you were expecting a GenericValue, eg:

issue.priority.get("name") == "High"

This will no longer work, you should change it to:

issue.priority.name == "High"

Issue interface

Some methods on com.atlassian.jira.issue.MutableIssue have been renamed. Previously, setComponents used GenericValues. However, the API was changed to use component objects instead. GenericValues were subsequently removed, so specifying "Objects" in the method name was no longer necessary.

setComponents(Collection<org.ofbiz.core.entity.GenericValue> components) has been removed, and setComponentObjects(Collection<ProjectComponent> components) has been renamed to setComponent.

Create Project

The validateCreateProject where you specify all the parameters has been replaced by:

ProjectService.CreateProjectValidationResult validateCreateProject(ApplicationUser user, @Nonnull ProjectCreationData data)

For how-to questions please ask on Atlassian Answers where there is a very active community. Adaptavist staff are also likely to respond there.

Ask a question about ScriptRunner for JIRA, for for Bitbucket Server, or for Confluence.