Link Connect app to its Forge equivalent

Let workspace admins discover and install the Forge version of your Connect app in Bitbucket. Add the Forge installation link to your Connect app descriptor under the forgeAppLink key, then update installations based on whether your app is Shared or Classic.

1. Update Connect descriptor with Forge app link

1. Share your Forge app to get its installation link.

2. Add a forgeAppLink key to the root of your Connect app descriptor JSON, using the Forge installation link as the value. For example:

   1
   2
   {
     "key": "my-connect-app-key",
     "forgeAppLink": "https://developer.atlassian.com/console/install/my-app-id?signature=1234567890&product=bitbucket",
     ...
   }
   

2. Update installations by your Connect app type

Before updating the installations, ensure that you're serving the latest Connect app descriptor with the forgeAppLink changes. The steps to update installations differ based on whether your app is Shared or Classic.

After updating the installations, workspace admins will see a new Get the Forge app link in their Manage installed apps page. This provides a direct link to install the Forge version of your app.

Next steps

• Verify that the Get the Forge app link shows up in the workspace settings.
• Notify customers that a Forge version of the app exists, and recommend that they upgrade to it.
• Monitor installations and errors..