Releases

A release is a version you ship, such as 2.4.0. Items are planned into a release through their Fix version field, and the release page shows how close it is to done. Projects made from the Software templates use releases from the start; project admins can turn releases on or off in Settings → General → Features.

The Releases tab#

The Releases tab lists the project’s releases as Unreleased, Released and Archived. Select one to open its page: its status and dates, its description, its progress by items and points, its burn-up, and its items. On wider windows the list and the release’s page sit side by side.

You can select and copy a release’s name, dates and description on every device.

Create a release#

Project admins select New release and fill in:

Name: a version, such as 2.4.0. It must be unique in the project.
Description (optional).
Start date and Target date, both optional. The target date can’t be before the start date.

Put items in a release#

Set an item’s Fix version field in its Details, in the Table, or for many items at once with the Table’s bulk edit.
To take an item out, open the ⋯ menu on its row in the release page and choose Remove from this release. Any member who isn’t a guest can, while the release is unreleased. This works offline.

The release page’s view bar#

The release page has its own view bar over its items:

Filter by text and Filter, to narrow the items shown.
Group: by status (the default), assignee, priority, type, sprint, or no grouping.
Sort, and the project’s saved Views. Views you save here are the project’s, as in its other views.

The page always shows only this release’s items, even when a saved view names another fix version. The progress at the top always counts every item in the release, whatever the filter. See Views, filters and saved views.

Release a version#

When the version ships, a project admin selects Release on the release page:

Pick the Release date (today by default).
If some items aren’t done yet, choose where they go: Move them to another unreleased release, or No release (clear their fix version).
Select Release.

Done and cancelled items keep the release as their fix version.

Edit, reopen, archive and restore#

These are for project admins:

Edit: change the release’s name, description, start date and target date, before or after it’s released. An archived release must be restored first.
Reopen: makes a released release unreleased again.
Archive: moves an unreleased or released release to Archived, after you confirm. Its items keep it as their fix version, and you can restore it later.
Restore: brings an archived release back, as released if it had been released, otherwise as unreleased.

Reopen, Archive and Restore are in the release page’s menu (More release actions). Items’ fix versions and the release notes page don’t change when you do any of these.

Release notes#

Select Generate release notes on the release page to write the notes as a page in the channel’s Docs tab. Any member who can edit the channel’s pages can, but not guests.

The page is titled with the release’s name and sits under a Release notes page that collects the project’s notes.
It lists the release’s done items under New features (epics and stories), Bug fixes (bugs) and Other changes (every other type). Open and cancelled items are left out.
The page is an ordinary page: edit it as you like.

Once notes exist, the button reads Update release notes. If someone edited the page since it was generated, the app asks Replace the edits? first: Replace writes the notes again, and Keep the edits leaves the page as it is. Select Open release notes to go to the page.

The burn-up report#

On a computer and the web, the Reports tab has a burn-up for each release: the total scope and the work done day by day. For an unreleased release, it projects a finish date from the last week’s pace and says whether the release is on track or behind its target date. Select Show as a table to read the numbers. Reports need a connection.

Releases also show on the project’s Calendar, on their target date.