jirafilters

This section describes the RN plug-in logic and covers use of JIRA filters for a few typical use cases, which you may need to adjust based on the way your team is using JIRA.

For comprehensive information about filtering and search capabilities that JIRA offers, see Atlassian Help

Note: The examples are intended to illustrate the syntax rather than to produce accurate results at any point in time. Because the status of JIRA issues changes continuously, the results of certain filter expressions may differ for the products used in the examples.

RN Plug-in Logic

Issue Placement

The table below illustrates how different JIRA issues are sorted into the three sections in a Release Note. Issues of the types that are not listed are not included into Release Note View.

Note: For any JIRA issue to appear in the generated RN, the issue must have a populated Release Note field.

A combination of the type and status determines the default placement of an issue in the generated RN.

RN Section Name	JIRA Issue Type	JIRA Issue Status
New In This Release	Improvement, New Feature	Closed, Code Done, Resolved
Corrections and Modifications	Task, Defect	Closed, Code Done, Resolved
Known Issues and Recommendations	Task, Defect	Open, In Progress, Reopened. Resolved or Closed with Resolution: Will Not Fix

Hot Fixes

Hot Fixes Use Case 1: Patch Request

This use case assumes that a Hot Fix is tracked in JIRA by means of a Patch Request issue, and that all the software changes that are relevant to this Hot Fix are tracked in JIRA as Improvements, Defects, and Tasks and are linked to the Patch Request issue.

To create a filter, specify the following text in Advanced Search.

Syntax:

issue in linkedIssues(<JIRA#>)

where <JIRA#> is the JIRA issue number for the Patch Request.

Example:

issue in linkedIssues("SIP-14601")

This filter returns all JIRA issues that are currently linked to the Patch Request issue. (In the example, it is a Patch Request for SIP Server.)

The same filter can be defined for a Hot Fix that is created as a Story in JIRA, as long as all relevant issues are linked to the Story issue.

Note: If any Improvement issues are included in the Hot Fix (for example, a new configuration option), they will appear in the New in This Release section in the generated Release Note.

Hot Fixes Use Case 2: No Patch Request

This use case assumes that a Hot Fix is tracked in JIRA by means of an issue other than Patch Request, but that a specific release number is used for the Fix Version/s field of each issue that has been corrected in the Hot Fix.

To create a filter, specify the project and fixVersion parameter.

Syntax:

project = <project_name> AND fixVersion = "<version>"

Example 1:

project = SS AND fixVersion = "statserv_8.1.000.43"

Example 2:

project = ICON AND fixVersion = "8.1.100.35"

This filter returns all JIRA issues that are currently Fixed or Code Done in the specified release number.

Note: If the product indicator is omitted in a freeze version in JIRA (such as statserv_ in the example), you may receive issues from other projects in your list. If this happens, fine-tune the filter to exclude other projects.

Hot Fixes Use Case 3: New Known Issues

Typically, the number of Known Issues that are added to a Hot Fix Release Note is low, and the JIRA numbers for these issues are communicated by the team. To include these issues into the filter, specify the issue IDs at the end of the search expression.

Syntax:

OR Key = <JIRA#>

Example:

The Stat Server filter used in Use Case 2 changes as follows to account for two new open issues:

project = SS AND fixVersion = "statserv_8.1.000.43" OR Key = SS-5529 OR Key = SS-5584

This filter returns two open JIRA issues in addition to the issues fixed in statserv_8.1.000.43 release (as long as they are still have an Open status).

General Release

General Release Use Case 1: Genesys Project

This use case assumes that a General Release is tracked in JIRA by means of a Genesys Project issue, and that all the software changes that are relevant to this General Release are tracked in JIRA as New Features, Improvements, Defects, and Tasks and are linked to the Genesys Project issue.

To create a filter, specify the following text in Advanced Search.

Syntax:

issue in linkedIssues(<JIRA#>)

where <JIRA#> is the JIRA issue number for the Genesys Project.

Example:

issue in linkedIssues("GIM-7746")

This filter returns all JIRA issues that are currently linked to the Genesys Project issue. (In the example, it is the v813 Genesys Info Mart Genesys Project.)

General Release Use Case 2: No Genesys Project

This use case assumes that a General Release is tracked in JIRA by means other than a Genesys Project issue. For a project like that, you can search for relevant fixes by defining a component, a range of Fix Versions, and/or a range of Resolved dates in your filter.

This use case can apply to a JIRA Project that covers multiple software components, with each component requiring a separate Release Note. In this situation, you can modify the filter from General Release Use Case 1 to return only the issues that relevant for a particular component.

General Release Use Case 3: New Known Issues

At the time of a General Release, it makes sense to review all the outstanding issues at the product team level and assess their addition to the component’s Release Note as Known Issues and Recommendations.

All Open Issues

To create a filter for Known Issues, specify the project name, applicable issue types, and issue status (include issues in Code Done or Reopened status, so that they are not lost).

Syntax:

project = <project_name> AND resolution = Unresolved AND "Release Note" is not empty ORDER BY updated DESC

Example:

project = GIM AND resolution = Unresolved AND "Release Note" is not empty ORDER BY updated DESC

The above filter returns all open issues ("Unresolved") that have Release Note information.

Note: To see all the open issues, regardless of Release Note information, remove the AND "Release Note" is not empty parameter from the search expression.

Customer-Reported Issues

You can limit the issues to those that were reported by the customer by filtering on the Customer Related flag, as follows.

Syntax:

project = <project_name> AND resolution = Unresolved AND "Release Note" is not empty AND "Customer Related?" = Yes ORDER BY updated DESC

Example:

project = GIM AND resolution = Unresolved AND "Release Note" is not empty AND "Customer Related?" = Yes ORDER BY updated DESC

Priority Issues

Additionally, your team may decide to focus on blocking, critical, and major customer defects only, for the Release Note purposes.

Syntax:

project = <project_name> AND resolution = Unresolved AND "Release Note" is not empty AND priority in (Blocker, Critical, Major) AND "Customer Related?" = Yes ORDER BY updated DESC

Example:

project = GIM AND resolution = Unresolved AND "Release Note" is not empty AND priority in (Blocker, Critical, Major) AND "Customer Related?" = Yes ORDER BY updated DESC

Recently Opened Issues

You can further limit the issues to those that were opened recently by filtering on the time when the issues were created. Specify the number of days during which issues may have been opened in the recent past, or use the date of the last General Release as the starting point in this filter.

Syntax:

created >= "-<N>d"

Example:

project = "SIP Server" AND created >= "-30d" AND "Release Note" is not empty ORDER BY updated DESC

Syntax:

created >= "YYYY/MM/DD"

Example:

project = "SIP Server" AND created >= "2014/09/30" AND "Release Note" is not empty ORDER BY updated DESC

Combining Fixes and Known Issues

You can build complex filters by combining various parameters into a single search expression. Moreover, one filter can combine an expression that searches for fixed issues with an expression that searches for open issues. When you do that, be careful about the choice of operators and the order of parameters. For more information about filters, click Syntax Help when you are in the Advanced Search view.

Complex Filter Example

Examples in this section illustrate how complex filters work. Example 1 provides filtering by date for open (Unresolved) issues that have Release Note information in JIRA. Example 2 provides filtering for issues that are linked to a Patch Request. Example 3 combines Example 1 with Example 2. Note the order of the two expressions and the use of the operator OR in Example 3.

Syntax:

<Filter 1> OR <Filter 2>

Example 1:

project = "SIP Server" AND created >= "2014/09/30" AND resolution = Unresolved AND "Release Note" is not empty ORDER BY updated DESC

Example 2:

issue in linkedIssues("SIP-14601")

Example 3 (Combined):

project = "SIP Server" AND created >= "2014/09/30" AND resolution = Unresolved AND "Release Note" is not empty OR issue in linkedIssues("SIP-14601") ORDER BY updated DESC