Knowledge Base

 View Only

How Releases Work

By Knowledge Base posted 07-05-2015 22:42


Releases are a great way to organize the delivery of a product, and Jama allows for a great deal of configuration. Note that a Release exists on the Project level, so it cannot be used with an embedded filter or reused to another Project. Users can, however, create a filter based on whether the criteria is or is not within a Release. If you need to use an embedded filter with your Releases, refer to this article on How to Use Round Trip for Editing.

Adding, Editing and Deleting a Release

Selecting the Releases tab from the Explorer Panel will display the existing Releases as well as Unassigned, the category in which any items not in a Release will be found. To add a Release, select Add Release at the top of the Explorer Panel when this tab is selected.

Next, fill in the Name, Description (optional), and Release Date. Keep in mind that nothing will happen when the Release Date is reached — it is for reference only. The Name, Description, and Release Date can all be edited at a later time.

The Release List will be a tab within the Configure Project menu. Configure Project can be accessed from either the Project drop-down menu or the gear icon next to the Project title. Here, admins and project managers are also able to add a Release as well as EditDelete, and Archive.  If a Release has active items, that Release will be unable to be deleted. If a Release is Archived, it will keep a version of the items within the Release. The items themselves will be free to be moved to other Releases or Unassigned while still being in the archived Release.

Release Explorer Settings
The gear icon next to Add Release leads to the Release Explorer Settings. Here, users can set default settings or their own personal settings. The purpose of this menu is to change what is viewable within the Release Explorer.

Among the settings that can be customized are the types of items viewable in the Release Explorer; whether to show Item IDs, Global IDs, Archived Releases, Downstream Relationships; whether to filter certain statuses; and whether to leave notes about the releases.

To finalize the settings, select Apply.

Adding Items to a Release
There are a few ways to add items to a Release; keep in mind that an item can belong to only one Release at a time. To keep a record of which version of an item existed in which Release, create a Baseline based on a particular release. 

To add an existing item to a Release, locate the Release field of the item in Single Item View or in List Vie, then select the desired release name from the drop-down menu. Make sure the field is configured as visible. Instructions on how to ensure that can be found here. You can also Batch Update the Release field or update them via a Round Trip export and import.

Right-clicking on the Release in the Explorer Tree will allow you to create a New Item within that Release. When the Item is created, specify where that Item will live (in a Set, Folder, etc.), and it will be instantly connected to that Release.

Sending a Release to Review
You can send the contents of a Release out for Review. Simply right click on the target Release and select Send for Review.

All of the items within that release will be sent to a Review in the Review Center. This will take you through the normal steps of setting up a Review and result in a fully functioning review with the contents of the Release.

Want a deeper dive involving Releases? A Jama consultant covered this topic in an “Ask Jama” session about Release Management.



09-06-2022 03:44

how does one get access to video? “Ask Jama” session about Release Management.

06-13-2018 16:45

Good article. FYI, some of the links are broken.

07-07-2015 11:08

We use release management for managing items incrementally. Each item in a release is meant to be applicable for future releases.

1) release 1: plan, build, and test a bicycle with two wheels
2) release 2: above + electrical motor for assisting going uphill
3) release 3: above + battery storage and charging system when breaking
4) release 4: above + gyroscope stabilized gimbals handlebar :-) 

07-07-2015 03:05

Matt, thanks for this great overview. Especially the links to related topics are helpful.

We are dealing with complete devices (electronics, software and mechanics). We are using the release field to distinguish between different device variants (e.g. different output options). We ran into trouble due to the fact that it wasn't defined what "release" really means. Is the requirement implemented only in this release or in this and all upcoming releases?

We are now using this definition:
- Leaving the field empty/unassigned means: Requirement is relevant for all releases
- Choosing a defined release means: The requirement has to be implemented for this release only"

@JAMA, Community: Do you have other definitions?


07-05-2015 22:54

Matt, thank you for a clear and concise overview of this important feature. Swoo