Checkhive – Checklists for Jira: User guide
Getting started
- Install Checkhive from the Atlassian Marketplace (Jira admin).
- Open any issue and choose Apps → Checkhive (the panel stays on that issue from then on). When a template is imported automatically, the panel appears by itself.
- Type an item in the box and press Enter. Start a line with
#for a header or##for a sub-header. Paste several lines to add them all at once.
Working with items
- Done: tick the checkbox. Other statuses: use the status menu at the end of the row.
- Due date, assignee, priority: hover over an item and click 📅 Due date, 👤 Assign or ⚑ Priority. Values that are set always show; click them to change. Use × to remove a date.
- Edit text: double-click the item, or ⋯ → Edit. Details: ⋯ → Add details.
- Reorder: drag the ⋮⋮ handle (drop on the upper or lower half of a row), or use ⋯ → Move up / Move down.
- Mandatory: ⋯ → Make mandatory (shown with a red
*). - Convert: ⋯ → Convert to header / Jira issue / sub-task. "Jira issue" opens Jira's create dialog pre-filled with the item; the item is removed only when the issue is created.
Headers and tabs
- A header's progress shows next to it (e.g.
2/5). Set status on a header changes every item under it. - ⋯ on a header: rename or delete (with or without its items).
- Tab view (toolbar icon or ⋯ → Switch to tab view): every
#header becomes a tab. Drag tabs to reorder them, or use the tab's ⋯ to rename, move or delete it. + adds a tab.
Text mode
Click ✎ to edit the whole checklist as text.
| Syntax | Meaning |
|---|---|
# Title / ## Title |
Header / sub-header (a # header is a tab in tab view) |
- item |
To do |
+ item |
Done |
~ item |
In progress |
x item |
Skipped |
-! item |
Mandatory item |
- [Blocked] item |
Custom status by name |
[priority="High"][dueDate="2026-09-13"][assignee="<accountId>"] |
Attributes right after the marker |
> text |
Details line for the item above |
**bold**, _italic_, `code`, [text](https://…), :tada: |
Formatting |
Templates
- New sites start with five ready-made templates (Definition of Done, Definition of Ready, Release checklist, Bug triage, New-hire onboarding). Edit or delete them like any other template.
- ⋯ → Save as a template turns the current checklist into a template.
- ⋯ → Import from a template adds a template's items to the issue.
- ⋯ → Manage templates: edit text, category and scope (global or project), order, duplicate, delete.
- Linked templates (template ⋯ → Convert to linked): editing the template updates every issue that uses it, while keeping each item's status, assignee and date.
Automation
In a template's settings:
- General: import automatically when an issue of the chosen issue types is created.
- Advanced: add triggers – Issue created or Issue transitioned (optionally from/to specific statuses) – each with conditions such as labels equals Onboarding. A template is imported only once per issue.
Workflow validator (mandatory items)
Jira only blocks a transition when its workflow contains the Checkhive validator, and only a Jira admin can add it.
- One click (recommended): Jira admin opens Project settings → Apps → Checkhive → Mandatory items, which shows whether the project is protected, and clicks Enforce in workflow. Checkhive adds the validator to every transition into a Done status of that project's workflows. Remove the rule takes it off again. If a workflow is shared with other projects, the page says so; the rule then applies to those projects too.
- By hand: Jira settings → Work items → Workflows → edit the workflow → select a transition → Validators → Add → "Checkhive - mandatory items completed".
- The transition is then blocked until every mandatory item is Done or Skipped, with a message listing the open items.
- To let every transition through in one project without changing the workflow, untick Enforce mandatory items in this project on the same page.
Project settings (project admins)
Project settings → Apps → Checkhive, or ⋯ → Manage checklist statuses in any issue:
- Custom statuses, each in a category (To do, In progress, Done, Skipped). Done and Skipped count as complete. Reorder with drag or the arrows; the first status of a category is used by the checkbox.
- Show the checklist in the issue body or the right-hand panel.
- Enforce mandatory items in workflows.
Boards, filters and JQL
The Checkhive progress field holds done/total (e.g. 3/8). Add it to board cards or filter columns, or search with JQL, e.g. "Checkhive progress" is not EMPTY.
History
Open Checkhive history under the checklist to see who changed what and when, including automation.
Limits
- Up to 500 rows and about 200 KB per checklist or template (long item details count towards this).
- History keeps the most recent changes and drops the oldest when it grows large.
Licence
Without an active licence, checklists stay visible but cannot be changed, automation pauses and the validator does not block transitions. A banner tells admins to renew the app in Manage apps.
Privacy
Checkhive stores checklist content and Atlassian account ids only (no names or emails), inside Atlassian's cloud. When an Atlassian account is closed, its id is removed automatically.
Support
Email support@checkhive.app or see the support page.