Release Picker for Jira: Docs

Getting started

1. In Jira settings, go to Work items then Fields (custom fields) and create a field. Choose the field type Release picker.
2. Give it a name, for example Target release, and add it to the screens or work types where you need it.
3. Open the field’s context and set which releases it offers (see below). Each context can have its own settings.

Field settings (per context)

• Offer releases from these projects: pick one or more projects. Leave it empty to offer only the work item’s own project.
• Also offer releases from the work item’s own project: on by default when you pick other projects.
• Offer releases from every project (up to 50): offers releases from every project the person can browse, up to 50 projects.
• Include released versions and Include archived versions: choose whether those versions are offered. Unreleased versions are always offered.
• Allow more than one release: lets people pick several releases. Most releases per work item sets the limit, from 1 to 20.
• Order in the list: release date (next release first) or project, then version name.

The settings panel shows a one-line summary of what the field will offer before you save.

Using the field

Click the field and type to search. Each option shows the project key, release name, status and release date. The field shows each picked release as a link to the release page, with a status lozenge and its date.

Searching with JQL

Put the field name and property inside quotes: - "Target release.Release" = "Platform 4.2" finds work with that release name. - "Target release.ReleaseProject" = PLAT finds work with any release from project PLAT. - "Target release.ReleaseId" = 10042 finds work with that exact version id. - "Target release" ~ "4.2" is a text search across the picked releases.

Validation

Jira checks the value on every edit and create path, including the API. It rejects a release from a project the field does not offer (“One of the releases is from a project this field does not offer.”) and more releases than allowed (“Choose one release.” or “Choose up to N releases.”).

Permissions

Releases load as the person using the field, so Jira’s Browse projects permission decides which releases they see. The app stores nothing beyond the field value and makes no calls outside Atlassian.

Limits

• Up to 50 projects per field context and up to 20 releases per work item.
• If a release is renamed, the field shows the new name the next time the value is saved; JQL by ReleaseId always matches.
• Release Picker does not change Jira’s own Fix versions field or release reports.

Need help?

See Support.