SupportBook a demoTry it free

Release checklist template set for Jira

Turn your release steps into a checklist that arrives with every version: freeze, test, document, publish and tell support, in the same order each time.

1 work item · 9 checklist items · On request

Read: A Jira release checklist you build once

Illustration of the Versioning and release template set in the app, with sample data.

The structure

What it creates

Each run creates one work item named for the version, with nine checklist items on it. The checklist sits on the work item the team already looks at, so the steps get done instead of living in a wiki page no one opens.

If a step belongs to someone else, such as release notes from the product manager, move it out of the checklist and into its own work item with its own assignee.

  • Release $versionTask
    • Freeze the release branchChecklist
    • Run the release testsChecklist
    • Update the version in the docsChecklist
    • Write the release notesChecklist
    • Publish the release notesChecklist
    • Tell support what changedChecklist
    • Tag the releaseChecklist
    • DeployChecklist
    • Watch errors for a dayChecklist

Each line is a checklist item on the work item. Add, remove or reorder them in the template set.

What fills in

Variables

Variables fill in what changes from run to run. They work in text fields, such as the summary and description. A user variable fills in a person field, such as Assignee.

Variables in the Versioning and release template set
VariableWhat it fills inExample
$versionThe version number in the summary; a text variable you add28.1.0
$projectKeyThe space key, in the descriptionWEB

$version is a custom variable the app asks for. $projectKey is built in; the name comes from Jira’s older wording and works in spaces.

When it runs

How to run it

Use one way, or more than one. Each way creates the same structure.

  1. 01

    On request

    Apply it from the app when the work starts.

    The app asks for any variables, so each run carries its own details.

  2. 02

    From Jira Automation

    Call the app's API from a rule.

    Use this when an event in Jira, such as a field change, should start the work.

  3. 03

    From a workflow transition

    Add the app's post function to the transition that moves a release to Ready.

    This works in company-managed spaces. The set is applied the moment the work item moves.

Who it's for

Engineering teams that ship versions on a regular rhythm and keep forgetting the same step, often release notes or the support briefing.

It suits teams where release knowledge lives with one person who is about to go on holiday.

When not to use it

If your release is fully automated in a pipeline, keep the steps in the pipeline and use the set only for the human steps.

For a hotfix, a shorter set with just test, deploy and tell support may fit better.

Versioning and release: common questions

Can we link it to the Jira version?

Yes. Set the Fix version on the work item, or link the work item from the version’s release page.

What if we add a step?

Add it to the template set after the release where you noticed it was missing. The next version gets it.

Is there a guide?

Yes. Our post on building a release checklist covers the steps and when to split them into work items.

Other template sets that teams use alongside this one.

Browse the template library
$featureName
Write the spec
Build and test
Release and announce
ExampleProduct

Take each feature from idea to release the same way.

1 epic, 3 work items · On request

See the template set
Sprint $sprint kickoff
Confirm sprint scope
Update the board filters
Book the sprint review
+1 more
GuideEngineering

The kickoff epic and its work items, ready to apply at the start of each sprint.

1 epic, 4 work items, 1 subtask · On request

See the template set
Bug: $bugTitle
Reproduce the bug
Triage and assign
Verify the fix
ExampleEngineering

Report, triage and verify every bug with the same steps.

1 bug, 3 subtasks · On request

See the template set
Part of AppsDelivered

Repeatable work, delivered.

Building Jira apps since 2017.

AppsDelivered CommentsReuse your team's replies.See AppsDelivered CommentsAppsDelivered FeedsTurn new posts into work items.See AppsDelivered Feeds