Cannery for Jira: documentation
Comment templates for every Jira project type. Public knowledge base source.
Get started
- Install Cannery from the Marketplace (a Jira admin). Atlassian runs the 30-day trial.
- Jira admins: open Jira settings > Apps > Comment templates to add shared templates, or
Import a CSV (columns
name,body, optionalfolder,projects,target,then_status). - Everyone: open Apps > Comment templates to keep personal templates.
- On any issue, open the ... menu and choose Comment from template.
Use a template
- Search or pick from the list. Your recent templates come first.
- Answer the questions the template asks (for example Version).
- Check the text and the preview. Edit anything; "Undo my edits" refills from the template.
- Choose where it goes: Post as a comment or Add to the description.
- Optional: Who can see it (a project role), Internal note / Reply to customer in service projects, and Then move the issue (preselected if the template names a status).
- Press Post comment. The comment is yours: it carries your name and Jira's permissions apply.
Empty values (an unassigned issue, an empty custom field) and unknown variables are listed before you post.
Write a template
Plain text with markdown: **bold**, _italic_, `code`, - bullets, 1. numbers,
# headings, > quotes, ---, [links](https://example.com), fenced code blocks. Single line
breaks are kept.
Variables (press Show variables in the editor):
| Variable | Becomes |
|---|---|
{{issue.key}}, {{issue.summary}}, {{issue.url}} | Key, summary, link |
{{issue.status}}, {{issue.type}}, {{issue.priority}}, {{issue.duedate}} | Current values |
{{issue.labels}}, {{issue.components}}, {{issue.fixVersions}} | Comma-separated lists |
{{project.name}}, {{project.key}} | Project |
{{reporter.name}}, {{reporter.firstName}}, {{assignee.name}}, {{assignee.firstName}}, {{currentUser.name}}, {{currentUser.firstName}} | People |
{{@reporter}}, {{@assignee}}, {{@currentUser}} | Real @mentions (they notify) |
{{date.today}}, {{date.today+7}}, {{date.today-1}} | Dates (YYYY-MM-DD) |
{{field:Customer tier}}, {{field:customfield_10042}} | Any field, by name or id |
{{ask:Version}}, {{ask:Version|1.0}} | Asked when used, with an optional default |
{{pick:Severity|Low,Medium,High}} | A choice asked when used |
Saving warns about unknown variables and field names that don't exist on your site.
Who manages what
| Who | Can manage |
|---|---|
| Everyone | Their personal templates (unless a Jira admin turns personal templates off) |
| Project admins | Shared templates limited to projects they administer (Project settings > Comment templates, or Apps > Comment templates). Can be turned off |
| Template editor groups | Every shared template, including ones offered in all projects |
| Jira admins | Everything shared, plus settings |
Anyone can Copy a template they can see into their own personal set.
Import and export
- Export JSON keeps everything and uses project keys, so it imports on another site (sandbox to production, or after a Data Center migration where keys stay the same).
- Export CSV opens in any spreadsheet.
- Import takes either. Check first shows what would be created, replaced and skipped. Choose whether same-name templates are kept or replaced. Up to 300 templates per import.
- Project keys that don't exist on the site are reported; a template whose projects are all missing is skipped rather than shared with everyone.
Settings reference (Jira admins)
- Template editor groups: group names, comma separated. Each group is saved with its Jira group id, so renaming a group keeps it working. If a group is deleted, nobody gets editor rights through it and the settings page names it so you can pick it again.
- Comment visibility groups: a template limited to a group that was deleted in Jira is never posted without the restriction; posting is refused and the manage page names the group.
- Project admins can manage shared templates for their own projects: on by default.
- People can keep personal templates: on by default.
Limits
20,000 characters per template; 2,000 shared templates per site; 300 personal templates per person. Forge apps can't add buttons inside Jira's comment box, so templates open from the issue menu. Templates can't be used inside the Create dialog; use Add to the description after creating. No images or attachments in templates.
Troubleshooting
- Template not listed on an issue: it's shared with other projects or it's someone else's personal template.
- Status didn't change: the transition needs required fields or a workflow condition failed; the message says which. The comment was still posted.
- "Jira says you don't have permission": you lack Add comments or Edit issues on that issue.
Privacy
Runs on Atlassian. Templates, usage counts and settings live in Forge app storage on your site. Nothing is sent to Great Work or anyone else. Full policy: PRIVACY-POLICY.md.