Skip to content

Commit e856376

Browse files
danciaclaradanciaclara
committed
Releases
1 parent c467a3d commit e856376

2 files changed

Lines changed: 133 additions & 0 deletions

File tree

‎docs/.vitepress/config.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,10 @@ export default defineConfig({
424424
text: "Milestones",
425425
link: "/core-concepts/projects/milestones",
426426
},
427+
{
428+
text: "Releases",
429+
link: "/releases",
430+
},
427431
{ text: "Stickies", link: "/core-concepts/stickies" },
428432
],
429433
},

‎docs/releases.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
---
2+
title: Releases
3+
description: Group work items under named versions, track delivery progress, and publish changelogs to keep your team aligned on what ships and when.
4+
---
5+
6+
# Releases <Badge type="tip" text="Business" />
7+
8+
Releases give your workspace a dedicated space to group work items under a named version, monitor delivery progress, and publish a changelog. Whether you're shipping a minor patch or a major feature launch, Releases keep your team aligned on what's going in and how much is done.
9+
10+
## How Releases work
11+
12+
A release is a named version that pulls together work items from any project in your workspace. As those work items move through their states, the release tracks progress automatically. When you're ready to ship, the release becomes the place to publish a changelog for the rest of the team.
13+
14+
Releases live at the workspace level. This means a single release can span multiple projects — useful when a feature launch involves work across multiple projects.
15+
16+
![Release activation](https://media.docs.plane.so/releases/activate-releases.webp#hero)
17+
18+
## Activate Releases
19+
20+
> **Role**: Workspace Admin
21+
22+
1. Go to **Workspace Settings > Releases**.
23+
2. Toggle on **Enable Releases**.
24+
25+
Once enabled, **Releases** appears in the workspace sidebar for all members. Disabling the toggle hides the section but preserves all existing data — re-enabling restores everything.
26+
27+
## Set up tags and labels
28+
29+
> **Role**: Workspace Admin
30+
31+
Before your team starts creating releases, set up tags and labels to keep things organized. Both are managed from **Workspace Settings > Releases** and available across the workspace when creating or editing a release.
32+
33+
### Release tags
34+
35+
Tags categorize releases across your workspace — useful for filtering by type, environment, or team. Switch to the **Release tags** tab and click **Add Tag** to create one.
36+
37+
### Labels
38+
39+
Labels organize releases visually with a name and color. These are separate from the project-level work item labels. Switch to the **Labels** tab and click **Add Label** to create one.
40+
41+
## Create a release
42+
43+
![Create Releases](https://media.docs.plane.so/releases/create-releases.webp#hero)
44+
45+
1. Click **Releases** in the workspace sidebar.
46+
2. Click **Add Release**.
47+
3. Fill in the release details:
48+
49+
| Field | Description |
50+
| --- | --- |
51+
| **Title** | Required. A short name for the release — for example, "v2.4 — Dashboard refresh." |
52+
| **Description** | Goals, notes, or relevant links. |
53+
| **Status** | Unreleased (default), Released, or Cancelled. |
54+
| **Tag** | One or more tags from workspace settings. |
55+
| **Labels** | One or more labels from workspace settings. |
56+
| **Target date** | Planned ship date. |
57+
| **Lead** | Responsible owner, selected from workspace members. |
58+
59+
4. Click **Create Release**.
60+
61+
You'll land on the release detail page, where you can start adding scope and writing the changelog.
62+
63+
## Work with a release
64+
65+
Each release has three tabs: **Overview**, **Scope**, and **Changelog**.
66+
67+
### Overview
68+
69+
The Overview tab shows the release description, all selected properties, and a live progress tracker.
70+
71+
The progress bar fills proportionally as work items in the release are completed. Counters display completed work items (e.g., 18/22 — 82%), pending work items, and cancelled work items.
72+
73+
Click any property chip — Tag, Label, Lead, or Target date — to edit it inline. Click **Click to add description** to write or update the release description.
74+
75+
![Release overview](https://media.docs.plane.so/releases/release-overview.webp#hero)
76+
77+
#### Release status
78+
79+
A release moves through three statuses that reflect where it is in its lifecycle:
80+
81+
- **Unreleased** — the default status when a release is created. Work is still in progress, and the scope and changelog are being built out.
82+
- **Released** — the release has shipped. Use this to mark the release as complete and signal to your team that it's out.
83+
- **Cancelled** — the release was abandoned. Use this when a planned release is no longer going forward, so the scope and history are preserved without cluttering your active releases.
84+
85+
Click the status chip on the Overview tab to change it. The Releases list groups releases by their status, so updating this keeps your list organized and makes it easy to see what's active, shipped, or cancelled.
86+
87+
### Scope
88+
89+
The Scope tab lists all work items attached to the release, categorized by [state group](/core-concepts/issues/states#state-groups). This is the source of truth for what's in the release.
90+
91+
Click **Add work items** to search and attach items by title or ID. Work items from any project in the workspace can be scoped to a release. To remove an item, hover over it and click the remove icon.
92+
93+
A work item's existing state drives the progress calculation automatically — you don't need to mark anything as "done in release" separately.
94+
95+
![Release scope](https://media.docs.plane.so/releases/release-scope.webp#hero)
96+
97+
### Changelog
98+
99+
The Changelog tab provides a rich text editor where you write and publish a summary of what changed in the release.
100+
101+
The editor supports . Changes save automatically as you type. The changelog is visible to all workspace members who can access the release.
102+
103+
![Release changelog](https://media.docs.plane.so/releases/release-changelog.webp#hero)
104+
105+
:::tip
106+
Use the Scope tab to audit completed work items, then use the Changelog tab to write polished, user-facing notes based on that list.
107+
:::
108+
109+
## Tag work items with a Release property
110+
111+
Plane supports **Release picker** as a custom property type on work items. This makes the release a first-class attribute on any work item, so members can assign work to a release without navigating to the Scope tab.
112+
113+
### Add the Release property
114+
115+
> **Role**: Project Admin
116+
117+
To add the Release property to a work item type:
118+
119+
1. Go to **Project Settings > Work item Types**.
120+
2. Select the work item type you want to extend.
121+
3. Add a custom property of type **Release**.
122+
123+
Once added, the **Release picker** field appears in the work item detail view. Any project member can set which release a work item belongs to directly from there, and the work item will automatically appear in that release's Scope tab.
124+
125+
With release as a work item attribute, you can group, filter, and build dashboard views around release milestones, giving leadership visibility into delivery velocity per release.
126+
127+
:::tip
128+
When importing from Jira, Fix Version and Affects Version fields map cleanly to the Release property. Your release tagging data carries over without manual re-tagging.
129+
:::

0 commit comments

Comments
 (0)