Skip to main content

Jira App (Legacy)

The legacy LaunchNotes Forge app for Jira — installation, the in-Jira writing assistant, and roadmap sync.

This is the legacy Jira Forge app. It's in maintenance mode and we don't recommend it for new setups. To create announcements from Jira, use Smart Draft instead — it's more powerful (start from a saved filter, combine many issues across a release, mix in Confluence pages and files). The Forge app is only recommended if you need roadmap sync from inside Jira.

This guide explains how to install and set up the LaunchNotes Jira Forge App (legacy), which provides integration between LaunchNotes and Jira. Forge is Atlassian's development platform for building applications into the Atlassian product suite. This article covers installation and setup, the in-Jira AI writing assistant, and roadmap sync.


Installation & Setup

  1. Install the Jira app and configure access in the project settings.

  2. Select the LaunchNotes project to which you want to connect.

  3. From an issue, either link it to a roadmap item or generate an announcement using the AI writing assistant.

Detailed setup instructions:

To get started, locate and install the LaunchNotes Jira Forge App from the Atlassian Marketplace by going to Apps > Explore more apps and then search for LaunchNotes in the search bar.


Project settings

After installation, to establish a connection between your LaunchNotes project and Jira project navigate to Project settings > Apps > LaunchNotes > Configure Access.

You will be prompted to authenticate and log into your LaunchNotes account. Once logged in, you can enable a Project connection, configure your Announcement issue fields, and set up an Announcement prompt.


Project Connection

Select the LaunchNotes project from the list of your projects that you wish to connect to.


Announcement Issue Fields

Here you can select which fields you would like to include when generating an announcement. This is helpful as users often store information in custom fields which this functionality will enable them to access.

  • Select up to 5 fields

  • If issue fields are not selected, they will default to Description and Summary

Note: Certain fields containing unusable data, such as Atlassian-specific fields (e.g., Atlassian account ID), are automatically filtered out as announcements cannot be generated from them


Configuring custom announcement generation prompt

To further refine how announcements are generated users can override the default prompt used to generate announcements. This allows for customization of the tone, length, target audience, etc.

  • To switch back to the default prompt at any time click Switch to Default


AI Writing Assistant

The AI writing assistant in the Jira Forge app enables a Jira user to choose any Jira issue and automatically create an announcement draft from that issue along with any child issues marked as done. It can be configured by selecting up to five announcement issue fields, such as summary, description, and custom fields specified in the Jira project. It also has a customizable tone, length, and target audience, all of which can be set using the announcement prompt above. The draft is then pushed to LaunchNotes, simplifying the process of collecting source material and creating product update announcements.

How to generate an announcement:

In order to generate an announcement select any issue within Jira you are interested in generating an announcement from. This could range from broad epics to specific bugs.

This will open the editor, from here click on the LaunchNotes button.

Click on Generate announcement.

Note: The app will only recognize child issues marked as done. Any issues marked as in progress will not be recognized by the announcement generator. If there are no child issues, the app will use the parent issue.

Wait for the announcement to generate.

Once the announcement is successfully generated, the message Announcement Draft Generated will appear in Jira, displaying only an excerpt of the announcement. To view the entire generated announcement, click Open in LaunchNotes. If you wish to modify the tone, length, target audience, etc. of the generated announcement you can do so in the announcement prompt settings.

Click Continue.

You will now have access to your generated announcement inside of the LaunchNotes announcement editor. Here, you can review and make further edits, as well as configure the settings for your announcement before publishing.

From the announcement editor you can also post directly to Confluence. For more information see Publish an announcement to Confluence as a blog post.


FAQ

Can I tie multiple epics to a Generated announcement?

The integration will only extend one level down for parent-child relationships in Jira. This means an Epic can have child Epics, but it should not be expected that the child Epics' children will be retrieved. Furthermore, there is no restriction on the issue type. Users could have a custom issue type with children of a different type.

How do I change the announcement prompt?

You can change the prompt and announcement generations fields in the project settings for the LaunchNotes app.

Can I regenerate an announcement?

No, it will create a new draft announcement each time. Any unwanted announcement drafts can be archived.

Can I bring my own LLM model to use?

No, not at this time.

Where is the data stored?

LaunchNotes doesn't use your prompts and continuations to train any models or distribute them to third parties. All the data passed to the model is housed within our own infrastructure.


Roadmap Sync

LaunchNotes' roadmap syncing in Jira allows customers to generate, manage, and modify LaunchNotes roadmaps seamlessly, all from within Jira.

To access the LaunchNotes Roadmap integration, click on a Jira issue. This will open a window where you can find the roadmap control on the right side panel.

Whether you're starting a new project or want to link an existing epic to a LaunchNotes roadmap item, the app makes creating new roadmap items and connecting existing roadmap items easy.

Create a roadmap item

To create a new roadmap item click on the Jira Issue you are interested in associating the roadmap item with and then click Create in the bottom right corner. While any issue type can be connected to a LaunchNotes roadmap item, teams will typically connect Jira Epics.

From here you can enter the roadmap item Name, Select a stage to place the roadmap item in, Select and owner for the roadmap item & Select categories for the roadmap item.

Note: Stages, categories, and users are coming in from LaunchNotes not Jira.

When you are done click Create.


Connect a roadmap item

The ability to connect to an existing roadmap item is beneficial for users who have an existing epic in Jira and wish to connect it to an existing roadmap item.

To connect to an existing roadmap item click Connect in the bottom right corner.

Select a roadmap item from the dropdown menu and click Connect to save the selection.

Note: A Jira issue can only connect to one LaunchNotes roadmap item, while a roadmap item can be connected to to many Jira issues.


Updating roadmap items in LaunchNotes from Jira

Link to roadmap item in LaunchNotes

Clicking on the Roadmap Item name will open a modal containing a link to that item in LaunchNotes.

Clicking on continue will navigate you away from Jira and into the roadmap item editor within LaunchNotes.

Updating Roadmap Item Stage

Clicking on the current stage will open a modal where you can update the roadmap item's current stage.

Select a stage from the dropdown menu.

Update the Projected date

  • Clicking the calendar icon will open a modal that allows you to change the projected date for a roadmap item.

  • Clicking on the arrows icon synchronizes the projected completion date of the roadmap item with the current issue's due date. However, if the Jira issue due date changes after syncing, it will not resynchronize automatically. You'll need to manually synchronize it again using the sync button.

From the popup modal you can set the projected date and choose from four different formatting options for how you would like to display said date.

  • Do not display

  • Exact - April 30, 2024

  • Fuzzy - This month, next month, March 2024

  • Quarterly - Q2 - 2024

Update the owner

Click on the current owners name, to change the owner of the roadmap item. The owner must be a LaunchNotes user, and this field will not be displayed outside of the LaunchNotes Management Portal.

Update the associated categories

Click on the dropdown menu next to categories to add or remove the categories associated with a roadmap item.

Action: Post update

Post updates to roadmap items from Jira

  • Defaults to internal update

  • This provides the ability to add updates into the timeline of the roadmap item, and optionally including those updates in the published timeline for the item.

  • Checking Notify Roadmap item Subscribers and team members will send an email containing the update to your LaunchNotes project internal team members and subscribers of the connected roadmap item. Only subscribers to the specific roadmap item will be notified.

Once you submit the update it will also show up on the timeline for the roadmap item in LaunchNotes.

Note: Even if Display timeline on roadmap? is toggled on, internal updates will not be shown on the published roadmap item.

Action: Ellipse Button

Click on the ellipse button to

  • View Published Roadmap Item: If the roadmap item is on a published stage click to view the roadmap item from your LaunchNotes page

  • Disconnect Roadmap item: Dissociates the Jira issue from the LaunchNotes roadmap item

Updating a roadmap items stage from inside LaunchNotes will show up in Jira as a comment.

Connecting Roadmap items in LaunchNotes to issues in Jira

LaunchNotes users also can connect a roadmap item to a Jira issue from within LaunchNotes. This provides bi-directional control of the connection between LaunchNotes roadmap items and Jira issues.

Did this answer your question?