Forge app manifest issuePanel:key displayed to Jira end users in 4 cases - is issuePanel:title a better fit?

Hi there Forge Platform team,

It seems the incorrect field from the Forge app manifest (manifest.yml) is being used in the following cases:

Case 1: for updates an app makes to an issue resulting in Issue History tab entry - the text displayed next to the app Avatar displays the App manifest.issuePanel.key - rather than the app name, that is - the following text from the manifest.yml is displayed:

modules:jira:issuePanel:key

As can be seen below (notice envision-smart-guess):

Case2 On app-icon mouse-over from the image above
Displays again

modules:jira:issuePanel:key

As can be seen here:

Case 3 When clicking “View profile” button from the image above
Displays again

modules:jira:issuePanel:key

As can be seen here:

Case4 Develoer console
Displays again under the header - “App name”

modules:jira:issuePanel:key

As can be seen here:

Solution:
In all cases it seems to be better fit to display

modules:jira:issuePanel:title

Which is a more human readable presentation of the app name.

Notice the issuePanel:title is used in the Jira issue view next to the icon, see image below, so it also makes sense to use it in all of these cases next to the icon.

Also notice that modules:jira:issuePanel:key is required to match the following pattern “^[a-zA-Z0-9_-]+$”. Which never makes sense to present to Jira end users.

FYI @kchan

All the best
Björn Brynjar

2 Likes

Hey @bjornbrynjar,

Thanks for raising this issue. We are working on a fix and will get back to you with more updates as that progresses.

2 Likes