Skip to content

Commit 655c378

Browse files
danciaclaradanciaclara
committed
formatting fixes
1 parent 1c39391 commit 655c378

2 files changed

Lines changed: 44 additions & 47 deletions

File tree

‎docs/automations/custom-automations.md‎

Lines changed: 42 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -101,24 +101,24 @@ Open any automation and click the **Activity** button on the top right. You'll s
101101

102102
### Triggers
103103

104-
| Trigger | Fires when |
105-
|---|---|
106-
| Work item created | A work item is created |
107-
| Work item updated | Any field on a work item changes |
108-
| State changed | A work item's state changes |
109-
| Assignee changed | An assignee is added or removed |
110-
| Comment added | A comment is added to a work item |
111-
| Scheduled | A configured time or cron schedule is reached |
104+
| Trigger | Fires when |
105+
| ----------------- | --------------------------------------------- |
106+
| Work item created | A work item is created |
107+
| Work item updated | Any field on a work item changes |
108+
| State changed | A work item's state changes |
109+
| Assignee changed | An assignee is added or removed |
110+
| Comment added | A comment is added to a work item |
111+
| Scheduled | A configured time or cron schedule is reached |
112112

113113
#### Scheduled trigger options
114114

115-
| Option | Notes |
116-
|---|---|
117-
| Daily | Runs once a day at the time you set |
118-
| Weekly | Runs on the days of the week you pick, at the time you set |
119-
| Monthly | Runs on the day of the month you pick (1–31), at the time you set |
120-
| Cron | Enter a 5-field cron expression for custom schedules |
121-
| Time | Hour and minute (0–23 and 0–59) |
115+
| Option | Notes |
116+
| -------- | ------------------------------------------------------------------- |
117+
| Daily | Runs once a day at the time you set |
118+
| Weekly | Runs on the days of the week you pick, at the time you set |
119+
| Monthly | Runs on the day of the month you pick (1–31), at the time you set |
120+
| Cron | Enter a 5-field cron expression for custom schedules |
121+
| Time | Hour and minute (0–23 and 0–59) |
122122
| Timezone | Defaults to the project timezone, then workspace timezone, then UTC |
123123

124124
### Conditions
@@ -127,42 +127,42 @@ Conditions let you filter which work items an automation acts on. You can combin
127127

128128
#### Fields you can filter on
129129

130-
| Field | What it checks |
131-
|---|---|
132-
| State | The work item's current state |
133-
| Priority | Urgent, High, Medium, Low, or None |
134-
| Assignees | Who the work item is assigned to |
135-
| Labels | Labels applied to the work item |
136-
| Work item type | The type set on the work item |
137-
| Created by | Who created the work item |
130+
| Field | What it checks |
131+
| -------------- | ---------------------------------- |
132+
| State | The work item's current state |
133+
| Priority | Urgent, High, Medium, Low, or None |
134+
| Assignees | Who the work item is assigned to |
135+
| Labels | Labels applied to the work item |
136+
| Work item type | The type set on the work item |
137+
| Created by | Who created the work item |
138138

139139
#### Operators
140140

141-
| Operator | Use when |
142-
|---|---|
143-
| Is | The field exactly matches a specific value |
144-
| Is not | The field does not match a specific value |
145-
| In | The field matches any value in a set |
146-
| Contains | The field includes the value |
147-
| Greater than | The field is greater than the value |
141+
| Operator | Use when |
142+
| ------------------------ | ----------------------------------------------- |
143+
| Is | The field exactly matches a specific value |
144+
| Is not | The field does not match a specific value |
145+
| In | The field matches any value in a set |
146+
| Contains | The field includes the value |
147+
| Greater than | The field is greater than the value |
148148
| Greater than or equal to | The field is greater than or equal to the value |
149-
| Less than | The field is less than the value |
150-
| Less than or equal to | The field is less than or equal to the value |
149+
| Less than | The field is less than the value |
150+
| Less than or equal to | The field is less than or equal to the value |
151151

152152
### Actions
153153

154154
#### Change property
155155

156156
Updates a field on the work item.
157157

158-
| Property | What you can do |
159-
|---|---|
160-
| Priority | Set, add, or remove a priority level (Urgent, High, Medium, Low, None) |
161-
| State | Move the work item to a specific state |
162-
| Assignees | Add or remove assignees |
163-
| Labels | Add, remove, or replace all labels |
164-
| Start date | Set, update, or remove the start date |
165-
| Due date | Set, update, or remove the due date |
158+
| Property | What you can do |
159+
| ---------- | ---------------------------------------------------------------------- |
160+
| Priority | Set, add, or remove a priority level (Urgent, High, Medium, Low, None) |
161+
| State | Move the work item to a specific state |
162+
| Assignees | Add or remove assignees |
163+
| Labels | Add, remove, or replace all labels |
164+
| Start date | Set, update, or remove the start date |
165+
| Due date | Set, update, or remove the due date |
166166

167167
#### Add comment
168168

@@ -218,18 +218,16 @@ Since there's no work item that kicked off the run, Plane has nothing to apply a
218218

219219
Scheduled automations check whether they're due roughly every 5 minutes. The time you configure follows your project's timezone, falling back to the workspace timezone, then UTC.
220220

221-
222221
### Why your trigger isn't enough on its own
223222

224-
Triggers tell Plane *what type of event* to watch for — not which work items to care about. A "state changed" trigger fires for every single state change in the project, across every work item, regardless of type, priority, or who it's assigned to.
223+
Triggers tell Plane _what type of event_ to watch for — not which work items to care about. A "state changed" trigger fires for every single state change in the project, across every work item, regardless of type, priority, or who it's assigned to.
225224

226225
Without conditions, an action like "set priority to Urgent" would run on every state change in the project. That's almost never what you want.
227226

228227
Conditions are what make an automation surgical. They let you say "only run this when the work item is a Bug, assigned to this person, with no due date set" — whatever combination of criteria actually defines the case you're building for.
229228

230229
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.
231230

232-
233231
## Common use cases
234232

235233
Some common things people use automations for.
@@ -242,4 +240,4 @@ Some common things people use automations for.
242240

243241
- **Contextual reminders.** Surface the right information at the right moment — for example, post an internal comment with a checklist when a work item enters "Ready for QA," or flag missing information when a work item is created without an assignee.
244242

245-
- **Scheduled operations.** Run scripts on a timer to handle things that don't map to a single event — for example, sweep stale items weekly, sync data to an external tool nightly, or generate a status comment on open items every Monday morning.
243+
- **Scheduled operations.** Run scripts on a timer to handle things that don't map to a single event — for example, sweep stale items weekly, sync data to an external tool nightly, or generate a status comment on open items every Monday morning.

‎docs/automations/overview.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ Plane sends in-app and email notifications to assignees and subscribers when a w
4848
2. Toggle on **Auto-reminders**.
4949
3. Set the **Send reminder before** timing — for example, 3 days before the due date.
5050

51+
Only work items with a due date and at least one assignee or subscriber trigger reminders.
5152

52-
Only work items with a due date and at least one assignee or subscriber trigger reminders.
53-
54-
Plane sends one reminder per window — not a daily flood. If you've set a 3-day reminder and the due date is 3 days away, each person gets one notification.
53+
Plane sends one reminder per window — not a daily flood. If you've set a 3-day reminder and the due date is 3 days away, each person gets one notification.

0 commit comments

Comments
 (0)