Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,14 @@ export default defineConfig({
{ text: "Custom Relations", link: "/work-items/custom-relations" },
{
text: "Automations",
link: "/automations/custom-automations",
collapsed: true,
link: "/automations/overview",
items: [
{
text: "Custom automations",
link: "/automations/custom-automations",
},
],
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion docs/automations/custom-automations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Automate project tasks with trigger based workflows
description: Automate repetitive project tasks with trigger-based workflows. Set up rules to automatically update work item properties, assign team members, and manage priorities when specific conditions are met.
---

# Automations <Badge type="tip" text="Business" />
# Custom automations <Badge type="tip" text="Business" />

Automations let you streamline your project management workflow by automatically performing actions based on specific triggers and conditions. This powerful feature eliminates repetitive manual tasks, ensures consistency in your processes, and helps your team maintain focus on high-value work by letting the system handle routine operations.

Expand Down
45 changes: 45 additions & 0 deletions docs/automations/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Automate project tasks with automations
description: Automate repetitive project tasks in Plane.
---

# Automations

Automations handle repetitive project work so your team can focus on the work that matters. Plane offers two kinds of automations, both configured in **Project Settings → Automations**.

- **Built-in automations** are ready-to-use toggles for common housekeeping tasks — archiving closed work items, closing stale ones, and sending deadline reminders.

- **[Custom automations](/automations/custom-automations)** let you build your own trigger-condition-action workflows — like auto-assigning a reviewer when a work item moves to QA, or adding a label when priority changes.

![Automations](https://media.docs.plane.so/automations/automations.webp#hero)

## Auto-archive closed work items

Automatically archive work items that have been completed or cancelled, keeping your active views clean.

1. Navigate to **Project Settings → Automations**.
2. Toggle on **Auto-archive closed work items**.
3. Set the **Auto-archive work items that are closed for** duration. Options include 1 month, 3 months, 6 months, 9 months, 12 months, or a custom time range.

Once enabled, work items that have been in a completed or cancelled state for longer than the configured duration are archived automatically. Archived work items remain searchable and accessible in the project's archived view, but they no longer appear in active lists, boards, or spreadsheets.

## Auto-close work items

Automatically close work items that have been inactive — not completed or cancelled — after a period you define. This prevents stale work items from cluttering your project indefinitely.

1. Navigate to **Project Settings → Automations**.
2. Toggle on **Auto-close work items**.
3. Set the **Auto-close work items that are inactive for** duration — for example, 1 month.
4. Choose the **Auto-close status** — the state that inactive work items will be moved to (e.g., Cancelled).

Work items that haven't been updated within the configured period are automatically moved to the selected auto-close status. Only work items that are not already in a completed or cancelled state are affected.

## Auto-reminders

Send automatic reminders via email and in-app notifications to keep your team on track with deadlines. When a work item's due date is approaching, assignees receive a reminder so nothing slips through the cracks.

1. Navigate to **Project Settings → Automations**.
2. Toggle on **Auto-reminders**.
3. Set the **Send reminder before** timing — for example, 3 days before the due date.

Once enabled, assignees and work item subscribers receive both an email and an in-app notification at the configured interval before each work item's due date. Only work items with a due date and at least one assignee or subscriber trigger reminders.
3 changes: 2 additions & 1 deletion docs/core-concepts/cycles.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Automate the creation and management of cycles according to predefined configura

1. Navigate to **Project Settings → Features → Cycles**.
2. Turn on the **Auto-schedule cycles** toggle and configure:
- Cycle Title — Set a naming convention for automatically created cycles.
- Cycle Title — Set a base name for automatically created cycles. Each cycle gets a numerical suffix appended automatically (e.g., if you set the title to "Sprint", cycles are created as "Sprint 1", "Sprint 2", "Sprint 3", and so on).
- Cycle Duration — Define the length of each cycle in weeks (e.g., 1 week, 2 weeks).
- Cooldown Period — Add an optional buffer between cycles in days for planning and retrospectives.
- Cycle starts day — Choose the start date for the first auto-scheduled cycle.
Expand All @@ -143,6 +143,7 @@ Once enabled, the system automatically:

- Generates the configured number of future cycles based on your settings.
- Creates a new cycle when the current one concludes to maintain the specified schedule.
- Numbers each new cycle sequentially, continuing from the last created cycle.
- Ensures cycles don't overlap and follow the defined cadence.
- Applies consistent naming conventions and durations across all cycles.

Expand Down
7 changes: 7 additions & 0 deletions docs/core-concepts/issues/display-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,25 @@ Grouping helps you organize work items based on shared attributes, making it eas
- Created By
- Milestones
- Epics
- Releases
- Work Item Types
- None

## Sub-group by

You can further refine your view by adding a sub-grouping. For example, you could group by State and then sub-group by Assignees to see the state of tasks per team member. Sub-grouping options include:

- State
- Priority
- Cycle
- Module
- Labels
- Assignees
- Created By
- Milestones
- Epics
- Releases
- Work Item Types
- None

## Order by
Expand Down
33 changes: 25 additions & 8 deletions docs/core-concepts/issues/issue-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,14 +95,14 @@ Before you delete properties, switch off the **Active** toggle button to avoid d

Here's a list of all the property types and attributes that Plane provides for creating custom fields:

| Property&nbsp;type | Attributes | Notes |
| ---------------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| **Text** | Single line, Paragraph, Read-only | The **Read-only** attribute cannot be marked as mandatory. Enter text in the Read only data box for this option. |
| **Number** | Default value | An optional default value can be given to this property type. |
| **Dropdown** | Single select, Multi select, Add options | Specify the values for the dropdown under **Add options**. |
| **Boolean** | True/False | Default value is false. This attribute cannot be marked as mandatory. |
| **Date** | Date Format | Consistent date format across all properties. |
| **Member&nbsp;picker** | Single Select, Multi select | Displays a list of all project members. |
| Property&nbsp;type | Attributes | Notes |
| ---------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Text** | Single line, Paragraph, Read-only | The **Read-only** attribute cannot be marked as mandatory. Enter text in the Read only data box for this option. |
| **Number** | Default value | An optional default value can be given to this property type. |
| **Dropdown** | Single select, Multi select, Add options | Specify the values for the dropdown under **Add options**. |
| **Boolean** | True/False | Default value is false. This attribute cannot be marked as mandatory. |
| **Date** | Date Format | Consistent date format across all properties. |
| **Member&nbsp;picker** | Single Select, Multi select | Displays a list of all project members. Members selected via a member picker property are automatically added as subscribers to the work item, so they receive notifications for updates, comments, and status changes. |

### Examples of custom properties

Expand All @@ -121,6 +121,7 @@ Once the project Admin sets up the work item types any project member can use th

- In the **Create new work item** modal, the user can choose the desired work item type from the list at the top left corner. By default, the work item type `Issue` is selected displaying both system-defined and custom properties.
- Changing the work item type will update the modal to display the relevant properties for that type.
- When a member picker property is filled in, the selected members are automatically subscribed to the work item. This means reviewers, stakeholders, or anyone added through a member picker stay informed without needing to be manually subscribed.
- The system ensures that all properties marked as mandatory are filled before creating the work item.

![Use work item types](https://media.docs.plane.so/issues/use-issue-type.webp#hero-tl)
Expand Down Expand Up @@ -154,6 +155,22 @@ You can change the work item types for several work items at once. Here’s how:

4. Click **Update** to apply the changes.

## Set the default work item type

The default work item type is pre-selected whenever someone creates a new work item. Initially this is set to the built-in `Issue` type, but you can change it to any active work item type.

1. Navigate to **Project Settings → Work item Types**.
2. Click the **…** menu next to the work item type you want to make the default.
3. Select **Set as default**.

The selected type now shows a **Default** badge and is automatically pre-selected in the Create new work item modal. You can change the default at any time by repeating these steps for a different type.

## Edit or delete work item types

To modify an existing work item type, click the **…** menu next to it and select **Edit**. You can update the name, description, icon, and background color.

To remove a work item type, click the **…** menu and select **Delete**. Existing work items of that type are not deleted — they retain the type until individually changed.

## Disable work item types

You can temporarily pause the creation of new work items for a specific work item type without affecting existing ones.
Expand Down
Loading
Loading