Last updated Feb 21, 2024

The Connect and Forge dev loop

Due to the flexibility and varied setups of existing Connect apps, we can't recommend a specific dev loop between the Forge and Connect parts of your app.

Whatever your setup, you now have some features available to help optimize your development lifecycle.

Handling app keys/environments

app.connect.key can and should be set differently in different environments (development, staging, production), but the field in your manifest (manifest.yml) is not environment-specific. This means app.connect.key needs to be changed to the appropriate key before running forge deploy into a different environment.

Learn more about Forge environments

What happens if you don't change it?

An app with the same app.connect.key can only be installed once on a single site.

The installation of a second app environment with the same app.connect.key app will be blocked.

When app keys can be changed

app.connect.key can be changed in any non-production environment at any time.

In production, your app.connect.key key should always match your existing Connect key to ensure upgrades work as expected.

What happens when I change my key?

app.connect.key is used by several Atlassian Connect features as an identifier, and these are affected by the change. For example, the app loses access to:

  • Any app properties it has written, such as the /rest/atlassian-connect/1/addons/{addonKey}/properties resource.

  • Certain existing configured modules identified by the key, such as workflow post functions.

  • Bookmarked URLs that include the app key, such as links to general pages, space tools tabs, or reports.

Automating app keys

We understand existing Connect developers may have their own way of automating app.connect.key changes. Due to the flexibility of developer environments with Connect, we don't have a specific recommended approach, though deploy.js has some code to automate this.

Tunneling your app

Tunneling allows you to run your Forge app code locally on your machine, making Forge development faster.

You could use tunneling with your existing methods of updating your Connect app to quickly test your changes.

Learn how to use tunneling in Forge

Managing multiple contributors

Forge allows you to control how different people can work together on your app.

Viewing metrics and logs

Once you've started using Forge, you can use the developer console to:

Some of these logs will only output data where your app is using Forge modules or functions.

Rate this page: