Custom JQL functions
- Yuri Kudin (Unlicensed)
- Yuri Lapin
- Yuri (Unlicensed)
Renaming “Releases“ to “Packages“
As of June, 2024 we re renaming “Releases“ to “Packages“ to be aligned with our Cloud products and avoid long running confusion with “Releases“ in Jira. Some areas of our App will still have release notion/naming due to technical limitations, namely:
API roots will still be called / release / while tags and descriptions in Swagger changed to packages
Webhook injectable variables will be called entity.*
Release notes injectable variables will be called release.*
JQL functions will still be called versionsOfReleases.. & issuesOfReleases..
Topics
Release Management App goes with a number of custom JQL functions, namely
“fixVersion in ..“ JQL functions
The below functions returns only a list of fixVersions managed by Release Management App. Virtual versions are not returned!
Function | Description |
|---|---|
versionsOfReleasesByName ("Board Name", "Package name") | Returns versions of package by package name |
versionsOfReleasesByStatus("Board name", "Package status") | Returns versions of package by package status (column or workflow step) |
versionsByStatus("Board name", "Version status") | Returns versions by version status (column or workflow step) |
versionsOfReleaseByTagInBoard("Board Name", "Tag name", “Optional: Tag name2“,…) | Returns versions from a board by tag(s). At least one tag has to be specified. Optionally, the user can specify multiple tags. In that case, the function will return version which has ALL specified tags (so, AND condition is used) |
versionsByTags("Tag name", “Optional: Tag name2“,…) |
|
versionsOfReleasesByName("Board Name", "Tag name", “Optional: Tag name2“,…) |
|
Let us provide few examples how the above functions could be used in real world scenario.
Find all issues which belong to packages in Done status fixVersion in versionsOfReleasesByStatus("My Board Name","Done")
Find all issues which belong to a particular package fixVersion in versionsOfReleasesByName("My Board Name","My Release Name")
Find all issues which belong to versions in "UAT" status fixVersion in versionsByStatus("My Board Name","UAT")
Find all issues which belong to versions with a tag “Regulation“ across all the board
Find all issues which belong to versions which have tags “Regulation“ and “USA“ at the same time across all the board
Find all issues which belong to versions which have tags “Regulation“ and “USA“ at the same time in “Portal releases board“
Find all issues which belong to versions in the package which have tags “Regulation“ and “USA“ at the same time in “Portal releases board“
|
“issue in ..“ JQL functions (ver. 4.1.0+)
The below functions returns a list of issues that belongs to all versions managed by Release Management App. So, virtual versions are taken in account as well - both JQL based and Epic based.
Function | Description |
|---|---|
issuesOfReleasesByName("Board Name", "Package name") | Returns all issues that belongs to cross-project release. I means all the issues will be returned from the versions (both fix versions and virtual versions) that comprises a cross-project release. |
issuesOfReleasesByStatus ("Board name", "Package status") | Returns all issues of cross-project release by release status (column or workflow step) |
issuesOfReleaseByTags("Board Name", "Tag name") | Returns all issues from all releases with a specified tag. |
issuesByVersionStatus("Board name", "Version status") | Returns all issues of versions by version status (column or workflow step). Both fixVersions and Virtual Versions are taken in account. |
issuesByVersionTags("Tag name") | Returns all issues from all versions with a specified tag, across all boards. |