Documentation

Upgrading and Versioning your Add-on

You can upgrade your add-on any time once it's listed in the Marketplace as either an approved public add-on or a private listing.

Almost all changes you make to your add-on will be to code inside your add-on's web app. For example, tweaking the look of a web panel, adding a configuration option or catching a previously unhandled exception can all be done by writing and deploying new code to your servers. Users see these changes as soon as you update your web app. In many cases (e.g. catching an exception or adding a configuration option) there isn't an immediate reason why end users should be aware of the change. When you change your descriptor file, we automatically update your version and build number in the Marketplace.

Automatic add-on polling & versioning

We automatically detect updates to Atlassian Connect add-ons with a polling service. This way, you can easily release fixes and new features without having to manually create new version entries in the Marketplace. We want to ensure that customers get the latest version of your add-on with as little delay as possible – Connect add-ons should seem like web services, not versioned software.

We poll the add-on descriptor URL that you included when you submitted your listing. When we detect a change, we automatically update your add-on in the Atlassian Marketplace with a new version. The way we increment your version number depends on the changes made to your descriptor.

Major, minor, and micro version update definitions

Updates are published to the Marketplace within a few minutes of detecting changes from your descriptor file.

We automatically build a version identifier for your add-on. How we increment your version number depends on the changes detected in your descriptor file. For example:

  • Major version (1.2.3 to 2.0.0): API version updates increment your major version. The major version matches the API version listed in your descriptor.
  • Minor version (1.2.3 to 1.3.0): Increase or changes in scope, and/or a transition from a free to paid model. Customers must manually approve updates for minor version updates.
  • Micro version (1.2.3 to 1.2.4): Any descriptor changes not included above that do not require manual approval.

Changes that require manual customer approval

Even though your add-on is automatically updated in the Marketplace, certain scenarios require customers to manually approve your add-on's update in the UPM. We automatically send emails to the product administrator so they can approve and update the add-on.

These scenarios require manual customer approval:

  • Your listing changes from free to paid: Your change triggers a Marketplace approval. Existing customers need to approve the change to start paying for your add-on, otherwise they will need to uninstall it.
  • Your listing involves additional scopes: Marketplace updates happen automatically (no approval necessary), but customers need to approve the changes to continue using your add-on.

Viewing automatically added versions

You can view add-ons in the Marketplace the same way you manage other add-on versions:

  1. Log in with your vendor credentials.
  2. Click Manage add-ons from the header.
  3. Click your add-on's name from the list.
  4. Click Versions in the horizontal navigation bar.

You'll see updates from Marketplace Hub [Atlassian]:

Marketplace Hub example