Getting started
What you need
- Jira Cloud. WhatShipped reads versions, sprints and resolved issues.
- Confluence Cloud on the same site, if you want to publish pages. You can still draft and copy text without it.
- A Jira admin to install the app from the Atlassian Marketplace.
Install
- In Jira, go to Apps > Explore more apps and search for WhatShipped.
- Choose Get app (or Try it free) and approve the permissions.
WhatShipped is installed on Jira. The same install asks for the Confluence permissions it needs to publish pages. Each permission is explained on the Security page.
Where it appears
| Place | What it is for |
|---|---|
| Project sidebar > WhatShipped | The main page: Releases, Digests, History and Voices tabs |
| Project settings > WhatShipped | Visibility rule, internal label, auto-draft, Confluence target, voices |
| Jira administration > Apps > WhatShipped | Site budget, model choice, retention, usage and errors (admins only) |
| A sprint's actions menu | WhatShipped: sprint digest |
Your first release note
- Open a Jira project and choose WhatShipped in the sidebar.
- On the Releases tab, tick a version.
- Choose the audiences you want. Customer is ticked by default.
- Check the estimate, for example "38 issues, about $0.14", then choose Generate.
- When the "Draft ready" card appears, choose Open.
There are no fields to fill in first. The three standard voices and the default visibility rule are already active.
What happens next
- Read the draft and its citations. See Review and edit.
- Choose Publish to Confluence. The first time, you pick a space and parent page. See Publishing.
- Set up a weekly digest if you want one. See Scheduled digests.
If a project has no versions
The Releases tab says so. You can:
- choose Try it on sample data to see a draft from example issues (sample notes cannot be published);
- use Generate from JQL on the same tab;
- digest a sprint from the Digests tab.
If nothing is found
By default WhatShipped only includes Stories, Bugs, Tasks and Improvements resolved as Done or Fixed. If nothing matches, the message shows how many issues were found and why each group was excluded, for example "type Feature not in rule". Choose Edit visibility rule to add your issue types or resolutions there and then. See Release notes and sprint digests.
Auto-drafts
When a version is released in Jira, WhatShipped drafts customer notes for it automatically. It never publishes them. You can turn this off in Project settings.