Last updated Nov 11, 2022

Rate this page:

Compass changelog

This page includes release notes and updates for Compass app developers. Use this page to keep track of new features, upcoming changes and deprecation notices about the Compass developer platform and GraphQL API.

Getting started

If you're new to building apps for Compass, check out Get started building Compass apps to begin your journey.

For updates about changes to the Forge platform, see the Forge changelog in the Forge documentation.

You may also be interested in the What's New blog for Atlassian Cloud where we announce new product features and other major changes affecting all users of Compass.

11 November 2022

Announcement Single value metrics in developer console

To quickly identify the current state of your Forge apps, the developer console now displays values, as well as charts, for each metric. For more information, see View app metrics.

2 November 2022

Announcement Grouping metrics by app version in developer console

To help you debug your Forge apps, the developer console now lets you group your metrics by app version. Each chart now has a Group by dropdown menu, with the option to select Version. For more information, see Monitor your apps.

26 September 2022

Announcement Forge app alert editing and alert history now available in developer console

In the developer console, you can now edit the title and description of your app alert, as well as view alert history. You can also see the metrics highlighted when value is below the threshold. For more information, see Manage app alerts.

23 August 2022

Announcement Identify errors across sites in developer console

To help you debug your Forge apps, the developer console now displays site-specific information about your app's invocation errors. Just select the invocation errors chart title, or select the More actions (⋯) menu on the chart and View details.

For more information, see Monitor your apps.

Announcement Introducing app alerts

To help you monitor the performance of your Forge app, we’ve introduced alerts for when your app’s invocation success rate changes. If your app’s invocation success rate falls below 99%, we’ll send you an email. If you don’t want to receive these emails, you can mute and unmute the alert at any time.

17 August 2022

Announcement Forge logs now available by default

EDIT, 17 Aug, 2022: This change was originally announced on August 15th, 2022. However the change was only made effective in production as of August 17th, 2022 (AEDT). Our apologies for any confusion caused.

To help you debug your Forge apps more easily, app logs are now available by default when a user installs your app on their site.

  • Previously log access was disabled by default. If you needed log access for your app on a user’s site, you had to ask the user to manually give you log access through Admin Hub.

  • Now log access is enabled by default. When a user installs your Forge app on their site, you will now have automatic access to logs for your app on their site.

Note, apps that are already installed will remain in their current state of log sharing, with log access disabled by default, but we are investigating how to change this.

Disabling access

Users can still manually disable or re-enable log access through Admin Hub. This will remove your access to the logs for your app on their site, including any historic logs that were generated when you previously had access.

11 August 2022

Added New Forge logging guidelines

To help you when handling logs for your Forge app, we have added new Logging guidelines for app developers. These guidelines outline some best practices to consider when handling logs and determining what data you should, and should not, be logging.

25 July 2022

Announcement New developer support page

We recently launched a new developer support page, which serves as a centralized hub for reporting issues, managing your app and getting support. This page will streamline your experience of getting in contact with us for different areas of support:

  • Bugs: Report development or Marketplace bugs

  • Incidents: Report critical issues or breaking changes

  • App listing: Edit your app or access Marketplace APIs

  • Accounts and payment: Manage your Marketplace payments and licenses

  • App migration: Get help with creating a cloud version of your app

  • Security programs: Apply or adjust your program details

  • Partner resources: Request access to exclusive partner content

  • Ukraine support: Request emergency concessions or ask questions

If you have any questions, please get in touch with us via the developer community announcement.

12 July 2022

Added Quick view of shared apps in developer console

To make it easier to track the performance of your shared apps, we’ve added quick-view cards on the developer console landing page, under a new ‘My shared apps’ section. These cards show your shared apps':

  • Invocation success rate for the last 7 days

  • Error count for the last 7 days

  • Last deployment event

More details

To see this change, log into the developer console, and if you’re sharing your app, you will see a card under ‘My shared apps’.

Here’s an example:

If you aren’t sharing any of your apps yet, see Distribute your apps.

31 May 2022

Announcement OAuth scopes in the Forge CLI

We’ve updated the Forge CLI to reflect the changes resulting from pausing the rollout of new scopes. Forge now supports classic and granular scopes. However, if your app doesn’t have all the scopes it needs, the Forge CLI suggests the recommended classic scopes instead of granular scopes.

Run npm install -g @forge/cli@latest on the command line to install the latest version of @forge/cli.

24 May 2022

Added New Compass data provider module

We’ve introduced the compass:dataProvider Forge module. This module enables apps to send events and metrics to Compass whenever specific links are added or modified on a component. For example, you could configure the module to send deploymentFrequency metrics to any component with a bitbucket.org repository link.

Learn more about creating a data provider app for events and metrics

8 March 2022

Added New Compass team page module

We’ve added support for a new compass:teamPage module in Compass. This module adds a menu item in the left navigation of the team page with an entry for this app. When the menu item is selected, content is rendered on a new page. Use the UI kit or custom UI to create content for the page.

Run npm install @forge/ui@latest on the command line in your app directory to install the latest version of the UI kit.

7 December 2021

Added Added Compass Global Page module type

Compass adds support for a global page module. This module adds a dropdown in the Apps section of the main navigation with an entry for this app. When the menu item is selected, content is rendered on a new page. Use the UI kit or custom UI to create content for the page.

Run npm install @forge/ui@latest on the command line in your app directory to install the latest
version of the UI kit.