Checking Plugins for API Compatibility

The Atlassian Plugin Checkup tool has been retired from service, you can read more about Checkup's retirement.

The Atlassian Plugin Checkup lets you test your plugin's compatibility with different versions of our products. It helps you identify API changes between versions of a product. 

Running the Atlassian Plugin Checkup

To use the Atlassian Plugin Checkup tool:

  1. Go to http://checkup.atlassian.com.
  2. Upload the JAR file that contains the plugin you want to check. You can load the JAR from a network location, by URL, or directly from your file system.
  3. Choose an Atlassian product and version.
  4. Run the report for the version.
  5. Fix your plugin to clear any warnings given by the checkup report.

Reading the Checkup Report

The checkup tool produces an online report showing a list of methods, parameters and other components that the plugin references in the Atlassian product. The report indicates the components that are:

  • Unavailable in the given version of the given product.
  • Deprecated.
  • Part of an internal interface.
  • Part of the stable, public API.

Below is a more detailed description of each of the categories, including guidelines on what you can do to fix the problem.

Category

Description

What to Do

Unavailable

The plugin refers to components that do not exist in the given version of the given Atlassian product.

Change the plugin so that it does not refer to these methods, parameters or other components. Check the product's reference documentation to see the available interfaces, and read through the product release notes and developer release notes for previous releases to see when the component was removed and what the recommended replacement is.

Deprecated

The plugin refers to components that have been deprecated, and will likely be removed in the next major version of the Atlassian product.

Check the product's reference documentation to see when and why the component was deprecated, and what the recommended replacement is. Read through the recent product release notes and developer release notes for more information on the changes. Update the plugin as soon as possible.

Private

The plugin refers to an internal class, interface or other component that is not part of the stable, public API. The referenced component may change in a future version of the Atlassian product. This may break your plugin.
Note: Currently only JIRA 5.0 is able to distinguish between internal components and public APIs. For all the other products, and for earlier versions of JIRA, all the available components will appear on this tab.

If you are not using JIRA 5.0, there is no need to take any action.
If you are using JIRA 5.0, you should change the plugin to use the public APIs where possible. See Preparing for JIRA 5.0.

Valid

These references made by your plugin are public, and are guaranteed not to change before the next major version of the Atlassian product.
Note: This tab will be empty for all products except JIRA 5.0. If you are not using JIRA 5.0, it's OK if there are no components listed here. If you are using JIRA 5.0, there should be a lot of information on this tab.

All good. No action required.

More Resources for Finding What Has Changed

If you cannot resolve an API compatibility problem, try searching Atlassian Answers. If no one has asked the question yet, add the question, giving it appropriate tags.

Coming Back to View the Report Again

The report remains available until someone generates it again for the same plugin and product version. You can bookmark the URL to view the report later.

References Checked by the Atlassian Plugin Checkup

The checkup tool checks all references made by the plugin to the following components:

  • Method calls
  • Method parameters
  • Types in method parameters and return types
  • Interface and class implementations and extensions
  • Annotations
  • Fields

Was this page helpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport