Skip to content

Commit 717852c

Browse files
authored
Plane Runner + Pre and post workflow conditions + Run script in custom automations (#427)
* Plane Runner * formatting fixes * Added pre and post workflow conditions * formatting fixes * Added script in Automations page
1 parent 0ca22d4 commit 717852c

4 files changed

Lines changed: 649 additions & 45 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -520,6 +520,10 @@ export default defineConfig({
520520
},
521521
],
522522
},
523+
{
524+
text: "Plane Runner",
525+
link: "/automations/plane-runner",
526+
},
523527
],
524528
},
525529
{

docs/automations/custom-automations.md

Lines changed: 41 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,65 +5,65 @@ description: Automate repetitive project tasks with trigger-based workflows. Set
55

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

8-
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.
8+
Custom 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.
99

1010
Think of automations as your digital assistant that watches for specific events in your projects and responds according to rules you define. Whether it's updating work item statuses, assigning team members, adding labels, or posting comments, automations work behind the scenes to keep your projects moving smoothly.
1111

1212
![Create automations](https://media.docs.plane.so/automations/create-automation.webp#hero)
1313

14-
## What automations do
14+
For built-in automations, see [Automations](/automations/overview).
15+
16+
## How custom automations work
1517

1618
Automations follow a simple but powerful logic: When [trigger] happens, if [conditions] are met, then perform [actions]. This trigger-condition-action framework allows you to create sophisticated workflows that adapt to your team's specific needs.
1719

18-
### Key components
20+
Every custom automation has three components.
21+
22+
**Triggers** are events that start the automation. A single event fires the automation, which then evaluates conditions before executing actions.
1923

20-
- **Triggers**
21-
Events that start the automation (work item created, updated, state changed, assignee changed, comment created)
24+
| Trigger | Fires when… |
25+
| ----------------- | ----------------------------------------------- |
26+
| Work item created | A new work item is added to the project |
27+
| Work item updated | Any property on a work item changes |
28+
| State changed | A work item moves to a different workflow state |
29+
| Assignee changed | A work item's assignee is added or removed |
30+
| Comment created | Someone adds a comment to a work item |
2231

23-
- **Conditions**
24-
Optional filters that must be met for the automation to proceed (specific state, type, label, assignee, creator, or priority)
32+
**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).
2533

26-
- **Actions**
27-
What the automation does when triggered (add comments, change properties)
34+
| Condition | Filters on… |
35+
| ---------- | ------------------------------------ |
36+
| State | A specific workflow state |
37+
| Type | A specific work item type |
38+
| Label | One or more project labels |
39+
| Assignees | Specific team members |
40+
| Created by | The person who created the work item |
41+
| Priority | A specific priority level |
2842

29-
You can create complex workflows by adding multiple conditions and multiple actions to a single trigger, giving you fine-grained control over when and how automations execute.
43+
**Actions** are what the automation does when fired. Multiple actions execute in sequence.
44+
45+
| Action | What it does |
46+
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
47+
| Add comment | Posts an automatic comment on the work item |
48+
| Change property | Updates a work item property: state, priority, assignee, labels, start date, or due date |
49+
| Run Script | Executes a [Plane Runner](/automations/plane-runner) script, giving you full programmatic control — call external APIs, create linked work items, enforce custom business logic, or anything else you can write in JavaScript or TypeScript |
3050

3151
## Set up automations
3252

3353
![Configure trigger and action](https://media.docs.plane.so/automations/configure-trigger-and-action.webp#hero)
3454

35-
1. Navigate to your Project Settings.
36-
37-
2. Select **Automations** on the left pane.
38-
3. Click **Create automation** to start building your workflow.
39-
- Give your automation a descriptive name and description.
40-
- Save the configuration.
41-
4. Click **Add trigger** in the trigger section.
42-
5. Choose from available trigger types:
43-
- Work item created
44-
- Work item updated
45-
- State changed
46-
- Assignee changed
47-
- Comment created
48-
49-
6. Click **Add condition** to specify when the automation should run. Select condition types such as:
50-
- State (specific workflow status)
51-
- Type (work item type)
52-
- Label (project tags)
53-
- Assignees (specific team members)
54-
- Created by
55-
- Priority
56-
57-
7. Click **Add action** to specify what the automation should do. Choose from available actions:
58-
- Add comment
59-
- Change property (State, Priority, Assignee, Labels, Start Date, Due Date)
55+
1. Navigate to **Project Settings → Automations**.
56+
2. In the **Custom automations** section, click **Create automation**.
57+
3. Give your automation a descriptive name and an optional description, then save.
58+
4. Click **Add trigger** and choose the event that should start the automation.
59+
5. Optionally click **Add condition** to narrow when the automation runs. You can add multiple conditions — the automation only fires when all conditions are met.
60+
6. Click **Add action** to define what happens. Choose from **Add comment**, **Change property**, or **Run Script** <Badge type="warning" text="Enterprise Grid" />. You can add multiple actions — they execute in sequence.
61+
7. Click **Enable** in the top right corner to activate the automation.
6062

6163
::: tip
6264
You can add multiple conditions to create more specific rules and multiple actions to perform several operations in sequence on a single trigger.
6365
:::
6466

65-
8. Click **Enable** on the top right corner of the screen to to start turn on the automation on your project.
66-
6767
## Manage automations
6868

6969
![Manage automations](https://media.docs.plane.so/automations/manage-automations.webp#hero)
@@ -95,17 +95,13 @@ Toggle automations on or off as needed without deleting them. This is useful for
9595

9696
## Common use cases
9797

98-
- **State management**
99-
Automatically transition work items between workflow states and update status when specific conditions are met.
98+
**State management.** Automatically transition work items between workflow states when conditions are met — for example, move a work item to "In Review" when an assignee is added, or to "Done" when all sub-items are completed.
10099

101-
- **Team assignment and handoffs**
102-
Automatically assign team members when work items reach specific stages, reassign work based on type or priority, and ensure proper handoffs between different teams or departments.
100+
**Team assignment and handoffs.** Auto-assign team members when work items reach specific stages. Reassign work based on type or priority to ensure proper handoffs between teams.
103101

104-
- **Priority and categorization**
105-
Auto-adjust work item priorities based on labels or assignees, apply consistent labeling across similar work item types, and maintain project organization through automated property updates.
102+
**Priority and categorization.** Auto-adjust priorities based on labels or assignees. Apply consistent labeling across similar work item types to keep projects organized.
106103

107-
- **Communication and notifications**
108-
Post automatic comments when work items are assigned or reassigned, add context when work items move between stages, and ensure stakeholders receive updates on critical changes.
104+
**Communication.** Post automatic comments when work items are assigned, reassigned, or move between stages. This keeps stakeholders informed without requiring manual updates.
109105

110106
---
111107

0 commit comments

Comments
 (0)