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
1 change: 1 addition & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,7 @@ if(n<200&&document.readyState==="loading")requestAnimationFrame(function(){bar(n
},
],
},
{ text: "Workspace Governance", link: "/workspace-administration/workspace-governance" },
{
text: "Authentication",
collapsed: true,
Expand Down
32 changes: 32 additions & 0 deletions docs/automations/custom-automations.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,26 @@ Every custom automation has three components. When [trigger] happens, if [condit
- **Conditions** are optional filters that must be satisfied for the automation to proceed. If you add multiple conditions, all of them must be met (AND logic).
- **Actions** are what the automation does when fired. Multiple actions execute in sequence.

## Where automations live depends on your plan

Every plan builds automations the same way, with the same triggers, conditions, and actions. What differs is **where** they are configured, **which projects** they can act on, and **which actions** are available. Find your setup below.

| Plan / setup | Where you configure automations | What you get |
| ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Business** | Inside each project, under **Project Settings → Automations** | Custom automations scoped to one project, with the **Change property** and **Add comment** actions. |
| **Enterprise Grid** (project-managed) | Project settings, plus **Workspace Settings → Automations** | Everything above, plus **workspace automations** that span all projects or a chosen subset, the **Send webhook** and **Run script** actions, and **scheduled** triggers. |
| **Enterprise Grid with [Workspace Governance](/workspace-administration/workspace-governance)** | Once for the whole workspace, under **Settings → Automations** | Automations are managed centrally by a workspace admin and applied to projects. Project admins no longer create or edit automations inside a project. |
Comment on lines +24 to +28

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Align the plan table with the project-automation steps.

The table limits Business project automations to Change property and Add comment. The later project-automation steps list Run Script without a plan guard. Clarify whether Business supports this action. If it is Enterprise-only, mark the later step as plan-specific.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/automations/custom-automations.md` around lines 24 - 28, Update the
project-automation steps referenced by the plan comparison table to clarify the
plan availability of the “Run Script” action. If the action is Enterprise-only,
add an explicit Enterprise plan qualifier or guard to that step; otherwise
update the Business row in the table to include it, keeping the documented
capabilities consistent.


**In short**

- On **Business**, automations live in **project settings** and act on that one project.
- On **Enterprise Grid without governance**, you keep project automations and can also create **workspace automations** and use the webhook and script actions.
- On **Enterprise Grid with [Workspace Governance](/workspace-administration/workspace-governance)**, automation management moves to the **workspace level**. Project admins can no longer edit automations inside a project. See [Automations under workspace g`overnance](#automations-under-workspace-governance).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Remove the stray backtick from the link label.

Change Automations under workspace g\overnancetoAutomations under workspace governance`.

🧰 Tools
🪛 LanguageTool

[style] ~34-~34: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...d use the webhook and script actions. - On **Enterprise Grid with [Workspace Gover...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🪛 markdownlint-cli2 (0.23.1)

[warning] 34-34: Link fragments should be valid

(MD051, link-fragments)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/automations/custom-automations.md` at line 34, Update the “Automations
under workspace governance” link label in the documentation to remove the stray
backtick from “governance,” leaving the link target and surrounding text
unchanged.


:::warning Turning on governance moves automations to the workspace
Enabling Workspace Governance is a one-way change that relocates automation management from individual projects to the workspace. Existing project automations are migrated up and keep running. Read [Workspace Governance](/workspace-administration/workspace-governance) before enabling it.
:::

## Create a custom project automation

Project automations apply to work items within a single project.
Expand Down Expand Up @@ -291,6 +311,18 @@ Conditions are what make an automation surgical. They let you say "only run this

One thing worth knowing: when a work item is first created, some fields like assignees and labels can take a moment to register, even if someone filled them in during creation. Plane handles this - it checks the latest state of those fields before evaluating your conditions, so a filter like "assignee is X" on a creation trigger will work as expected.

## Automations under workspace governance <Badge type="warning" text="Enterprise Grid" />

On **Enterprise Grid with [Workspace Governance](/workspace-administration/workspace-governance)** enabled, automations are managed once for the entire workspace instead of project by project. A workspace admin owns all automation configuration, and project admins can no longer create or edit automations inside a project.

You build these automations exactly as described above. This section covers only what's different when governance is on:

- **Project-level automation editing is locked.** Project admins can no longer create or edit automations inside a project. Opening an automation in a project shows it as read-only, with a message that automations are managed at the workspace level.
- **Existing project automations are preserved.** When governance is enabled, each project's automations are migrated up to the workspace level and scoped back to their original project, so they keep running exactly as before.
- **All automations are managed centrally.** A workspace admin creates and edits every automation under **Settings → Automations**, choosing whether each one applies to all projects or a specific subset.

See [Workspace governance](/workspace-administration/workspace-governance) for the full picture of what centralizes and what changes for projects.

## Common use cases

Some common things people use automations for.
Expand Down
100 changes: 85 additions & 15 deletions docs/core-concepts/issues/states.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
---
title: Workflow States
title: Work Item States
description: Manage work item progress with customizable states in Plane. Organize tasks through backlog, unstarted, started, completed, and cancelled state groups.
---

# Work Item States

Managing work items effectively is at the heart of every project, and Plane provides a robust system for organizing them into states that represent the stages of a work item's lifecycle. As work items transition through these states—from backlog to completion—they reflect the progression of work in your project, forming a clear and efficient workflow for your team.

## Where to configure states

Each project defines its own states, managed by a **project admin** under **Settings → (project) → States**. This is the default.

**Enterprise Grid - workspace level**
With [workspace governance](/workspace-administration/workspace-governance) enabled, states become a single shared set for the whole workspace, managed by a **workspace admin** under **Workspace Settings → States**, then applied to every project. Project admins use the shared set but can't edit it. See [Under Enterprise Grid governance](#under-enterprise-grid-governance).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Repair the invalid internal links.

  • Line [15] links to #under-enterprise-grid-governance, but the section heading is Under workspace governance. Use #under-workspace-governance or rename both references.
  • Line [63] uses [intake](#), which is an empty fragment. Link to the intake documentation or remove the link.

Also applies to: 63-63

🧰 Tools
🪛 markdownlint-cli2 (0.23.1)

[warning] 15-15: Link fragments should be valid

(MD051, link-fragments)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/core-concepts/issues/states.md` at line 15, Update the internal links in
the states documentation: change the governance reference on the line containing
“Under Enterprise Grid governance” to the existing “Under workspace governance”
anchor, and replace the empty intake fragment with the appropriate intake
documentation link or remove the link.

Source: Linters/SAST tools


The concept and most mechanics are identical either way; only where you configure them, who can, and a few behaviors differ.

## State groups

Every state belongs to one of five groups. The group is the meaning Plane attaches to the state; the name is your label for it.

![Work item states](https://media.docs.plane.so/projects/issue-states.webp#hero)

Plane organizes work item states into five primary groups, each serving a distinct purpose in your project’s workflow:
Expand All @@ -27,27 +38,86 @@ Plane organizes work item states into five primary groups, each serving a distin

- **Cancelled**: Use this group for work items that are no longer relevant or actionable. Plane provides a default state called **Cancelled** for this purpose.

## Customize states
### What groups drive

The group, not the state name, determines behavior across Plane:

- **Completion and progress** - only work items in the **Completed** group count as done. Cycle and module progress, burndown, and analytics bucket work items by group.
- **Archiving** - only work items in **Completed** or **Cancelled** states are eligible for automatic archiving.
- **Ordering** - states sort by group first, then by position within the group.

Because of this, **changing a state's group changes how its work items are counted**. Moving a state into Completed, for example, makes its work items count as done in every chart and progress bar.

## The default state

Exactly one state is the **default** - the state new work items get when none is chosen. New projects start with Backlog as the default.

To change it, open a state and choose **Mark as default**. The previous default is cleared automatically; there is always exactly one.

::: info **Enterprise Grid**
The default is not a flag on the state and there is no "Mark as default." The default is the **starting state of the workflow**, set on the [Workflows](/workflows-and-approvals/workflows) page. A governed workspace's default workflow starts at **Todo**.
:::

## Triage state

You can customize each state group to match your project's workflow by adding, editing, or removing states.
Triage is a special, system-managed state used as the holding area for [intake](#) submissions - items land in Triage before being accepted into the project's normal flow.

Navigate to the **States** tab under **Project > Settings**.
- There is **one triage state per project**, or **one per workspace** under governance.
- **"Triage" is a reserved name** - you cannot name a state Triage.
- You **cannot create** a state in the Triage group, and you **cannot delete** the triage state.
- Triage is kept out of normal state lists and excluded from analytics.

![Modify states](https://media.docs.plane.so/projects/project-new-state.webp#hero)
## Manage states

### Add state
States are shown grouped. Use the **+** on a group to add a state to it.

**Create** - set a **name**, a **color**, and an optional **description**. The group is determined by which group you add the state under. A duplicate name is rejected.

::: info **Enterprise Grid:**
State names must be unique across the **whole workspace**, and the check is **case-insensitive** - "Todo" and "todo" are treated as the same. (When governance is first enabled, same-named states from different projects are merged into one.)
:::

**Edit** - change the name, color, or description at any time. To change a state's group, drag it into another group.

**Reorder and regroup** - drag a state to reorder it within its group, or drag it into a different group to reassign it. You **cannot drag away the last state in a group** - every group must keep at least one state.

**Delete** - remove a state, subject to these rules:

- The **default state cannot be deleted**. Set a different default first.
- A state with **work items cannot be deleted** - there is no automatic reassignment. Move its work items to another state first, then delete it.
- The **triage state cannot be deleted**.
- A group's **last remaining state cannot be deleted**.

Deleting a state is permanent.

:::info **Enterprise Grid**
A state also **cannot be deleted while a workflow uses it** - the error names the workflows. Remove the state from those workflows first. Project admins cannot create, edit, or delete states at all; state management happens at the workspace level.
:::
Comment on lines +84 to +95

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Scope the deletion rules by governance mode.

Line [58] says governed workspaces do not have a state-level default. Lines [86] and [117] still say that the default state cannot be deleted and instruct readers to set another default. Keep that rule under project-managed settings. Describe governed deletion using workflow-reference rules, as stated on Line [94].

Also applies to: 115-123

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/core-concepts/issues/states.md` around lines 84 - 95, Update the
deletion rules in the state documentation to scope the default-state restriction
and “set a different default” instruction to project-managed settings only. For
governed workspaces, describe deletion using the workflow-reference restriction
already stated in the Enterprise Grid section, including the applicable workflow
behavior; apply the same governance-specific wording to the related section
around the additional referenced lines.


## Restricting work item creation in a state

Whether work items can be created directly in a given state is a **workflow** setting, not a property of the state itself. In a workflow, each state has an **allow work item creation** toggle; turn it off for states that should only be reached by moving an existing work item (like "Done"). See [Workflows](/workflows-and-approvals/workflows).

---

1. Click the "+" button next to the group where you want the new state.
2. Rearrange states within the group to reflect your preferred workflow.
## Under workspace governance

You can also designate a state as the default for the project. New work items without an assigned state will automatically fall into this default state.
When governance is on, states are a single **shared catalog** for the whole workspace:

### Edit state
- One shared set that every governed project draws from. A project's visible states are the ones used by the workflows its work item types resolve to.
- Names are unique across the workspace, case-insensitive.
- One workspace triage state.
- The default concept moves to the workflow's starting state.
- Project admins cannot edit states; deleting a catalog state is blocked while a workflow references it.

1. Hover over the state you want to edit.
2. Click the pencil icon and change the name and description.
3. Click **Update** to save changes.
See [Workspace governance](/workspace-administration/workspace-governance) for how governance works overall.

### Delete state
## Warnings and limitations

Before removing a state, ensure no work items are currently assigned to it. Once it's clear, you can delete the state by clicking the **x** icon on the state.
- **The default state cannot be deleted** - reassign the default first.
- **A state with work items cannot be deleted** - move those work items first; there is no automatic reassignment.
- **Every group must keep at least one state.**
- **"Triage" is reserved** and cannot be created as a group or deleted.
- **State names must be unique** - within the project, or across the workspace (case-insensitive) under governance.
- **Changing a state's group re-buckets its work items** for progress, analytics, and archiving.
- **Under governance**, a catalog state can't be deleted while a workflow references it, and project admins can no longer edit states.
Loading
Loading