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.
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.
As part of the Atlassian visual refresh updates, we updated the UI Kit Icon component. Some glyphs get a new look, and many more glyphs have been added. There are also a number of deprecations, as detailed below.
The size prop will only support the values "small" and "medium". The value "large" is now deprecated and will be removed.
The prop primaryColor has been renamed to color.
The prop secondaryColor is now deprecated and will be removed.
Some glyphs haven been replaced and others will be removed. Visit the Icon migration guide for information on finding a replacement.
The new default size for icons will change from 24x24 pixels to 16x16 pixels.
All deprecations and breaking changes will take place on Jan 1, 2026. Until then, the new Icon component will be fully backwards-compatible. Any deprecation will trigger a console warning prefixed with [@forge/react: Icon] on non-production environments.
The scorecardScore field on CompassScorecard has been deprecated. Use the score field on CompassScorecardAppliedToComponentsEdge instead.
The CompassScorecardAppliedToComponentsEdge field is part of CompassScorecardAppliedToComponentsConnection, available from appliedToComponents on CompassScorecard.
The scorecardScore field on CompassComponent has been deprecated. Use the score field on CompassComponentHasScorecardsAppliedEdge instead.
The CompassComponentHasScorecardsAppliedEdge field is part of CompassComponentHasScorecardsAppliedConnection, available from appliedScorecards on CompassComponent.
The scorecardScores field on CompassComponent has been deprecated. Use the score field on CompassComponentHasScorecardsAppliedEdge instead.
The CompassComponentHasScorecardsAppliedEdge field is part of CompassComponentHasScorecardsAppliedConnection, available from appliedScorecards on CompassComponent.
The scorecardScore field on CompassComponentHasScorecardsAppliedEdge has been deprecated. Use the score field on CompassComponentHasScorecardsAppliedEdge instead.
The scorecardCriteriaScore field on CompassScorecardCriteria has been deprecated. Use the criteriaScores field on CompassScorecardScore instead.
We’re introducing the ability for apps to publish events, allowing for enhanced interoperability between apps. This feature enables apps to subscribe to events using the existing https://developer.atlassian.com/platform/forge/manifest-reference/modules/trigger/ module, opening up new possibilities for app interactions.
Developers can start using app events by implementing the https://developer.atlassian.com/platform/forge/manifest-reference/modules/event/ module in their apps. For detailed guidance and examples, refer to https://developer.atlassian.com/platform/forge/events-reference/app-events/.
To publish events using the runtime API, you need at least version 2.0.0 of the @forge/events dependency. Add this to your package.json:
1
2
3
4
5
{
"dependencies": {
"@forge/events": "^2.0.0"
}
}Blob objects can now be sent and received via the events API. This enhancement allows for more efficient data handling and transmission within the API.
Update to the latest version of @forge/bridge with npm install --save @forge/bridge@latest
With the Forge CLI 11.5.0 release, we've enhanced the Forge platform to let you specify the memory available to functions at runtime by setting the memoryMB property in the Manifest (https://developer.atlassian.com/platform/forge/manifest-reference/#runtimev2) . Increasing the function memory also increases its CPU allocation. The memory value can now be set between 128 MB and 1,024 MB, doubling the previous limit of 512 MB. If you do not configure the function memory, the default memory allocation of 512MB applies to your function. This change helps address out-of-memory (OOM) issues by allowing higher memory allocation.
For more information on configuring Forge function memory, see https://developer.atlassian.com/platform/forge/manifest-reference/#runtimev2.
For details on the relationship between memory and CPU allocation, refer to the https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html.
Internationalization (i18n) for Forge apps is now generally available. This allows you to add translation support to your app so that it can adapt based on a user’s language and locale.
In addition to the Confluence and Jira modules that were supported during the EAP, internationalization support can now also be added to Bitbucket, Compass, and Jira Service Management modules, as well as Forge resolvers.
For more information, see Internationalization.
We fixed a problem with the @atlassian/forge-graphql package by addressing a dependency issue related to UI code and @forge/api upgrade. With this change, types cannot be imported from @atlassian/forge-graphql anymore.
Previously, importing types from @atlassian/forge-graphql in the frontend could lead to a Can't resolve async_hooks error during project builds due to its reliance on the backend module async_hooks.
To resolve this, we have introduced a new package, @atlassian/forge-graphql-types, made for importing types in the frontend. We have also removed the type generation from @atlassian/forge-graphql. This change was prompted by the recent upgrade of @forge/api to version 4.1.0, which introduced functions that depend on async_hooks. To upgrade, simply install the latest version of @atlassian/forge-graphql-types and import the types that no longer exists in @atlassian/forge-graphql from the new package.
We will not be issuing any new waivers for apps that need to request or store Atlassian user API tokens. This decision is part of our ongoing commitment to enhancing security and protecting customer trust.
Forge Apps that have already been granted waivers must ensure a lack of alternative solutions within Forge. They can continue to operate, but no additional waivers will be granted for new modules or new functionality within the same app.
Connect apps that have been granted waivers and any existing Connect app requesting or storing Atlassian user API tokens are required to migrate to Forge, with tokens stored in Forge encrypted storage.
For more details, read our FAQ
We have updated our UI Kit components, Text and Heading to make them more flexible:
Text
Now supports align, as, color, maxLines, size and weight properties.
For more information, see Text component documentation.
Heading
You can now control how the Heading component appears by setting a value for size, while the as prop controls the HTML element's rendering.
For more information, see Heading component documentation.
Following the deprecation announcement on 28 Aug 2024, we have now removed UI Kit 1 from the Forge platform.
For apps still using UI Kit 1, customers will see that their app version is outdated due to a deprecated platform component.
You will need to upgrade to the latest version of UI Kit for your app to work. If you are in the process of upgrading your UI Kit 1 app, please refer to these resources to guide you through the transition:
UPDATE, 02 Mar, 2025 The scheduled upgrade was successfully performed on March 02, 2025 between 12:30 AM to 03:30 AM UTC, and we have verified that all the capabilities mentioned below are working as expected. If you are experiencing ongoing issues with these capabilities please contact your local Atlassian site administrator. If you need further help, please raise a support ticket at https://support.atlassian.com/#contact.
EDIT, 28 Feb, 2025 : Please note that below mentioned times are UTC i.e. 02 Mar, 2025 between 12:30 am to 03:30 AM UTC
Forge platform will be undergoing maintenance on March 02, 2025 between 00:30 AM to 03:30 AM. During this interval, below capabilities will not be available intermittently:
Create/update/delete apps
Deploy apps
Install/uninstall/upgrade apps
View existing installations
App invocations will continue to work for existing users of the apps. However, new customers might not be able to use apps as consent process will be impacted during this interval as well.
Rate this page: