This changelog is the source of truth for all changes to the Bitbucket API and Bitbucket Connect API that affect people using Bitbucket Cloud and developing Bitbucket Cloud apps.
To ask any questions related to Bitbucket Cloud development please visit the Bitbucket Cloud developer community.
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 Atlassian Support
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.
As announced in a previous deprecation notice, on Feb 20, 2025 Bitbucket removed the List pull requests for a user API endpoint, which fetches pull requests authored by a given user across all of their workspaces. The removed endpoint now returns a 404 error.
Please migrate your usage to the replacement API endpoint, List workspace pull requests for a user.
We’ve added a new Bitbucket Forge product events: avi:bitbucket:created:commit-comment
. You can use these events to invoke your Forge app function when a commit comment is created. For more details see https://developer.atlassian.com/platform/forge/events-reference/bitbucket/.
All the Forge Bitbucket UI modules extension data now include a location
property, which is available by calling the useProductContext hook. It provides the full URL of the host page where the module is displayed in. For more details, see the https://developer.atlassian.com/platform/forge/manifest-reference/modules/index-bitbucket/.
The following Forge Bitbucket modules now support view.createHistory()
via @forge/bridge
:
bitbucket:repoMainMenuPage
bitbucket:repoSettingsMenuPage
bitbucket:workspaceSettingsMenuPage
App developers can now utilize a path segment at the end of the page URL to maintain page history within their app. For more details, see https://developer.atlassian.com/platform/forge/apis-reference/ui-api-bridge/view/#createhistory.
We’ve added two new Bitbucket Forge product events: avi:bitbucket:resolved:pullrequest-comment
and avi:bitbucket:reopened:pullrequest-comment
. You can use these events to invoke your Forge app function when a pull request comment is resolved or reopened. For more details see https://developer.atlassian.com/platform/forge/events-reference/bitbucket/.
We’ve introduced two new Bitbucket Forge product events: avi:bitbucket:created:build-status
and avi:bitbucket:updated:build-status
. You can use these to invoke your Forge app function when a build status is created or updated. For more details see https://developer.atlassian.com/platform/forge/events-reference/bitbucket/.
As mentioned in a previous deprecation notice, on Feb 20, 2025 Bitbucket will be removing the List pull requests for a user API endpoint, which fetches pull requests authored by a given user across all of their workspaces.
We have introduced a new endpoint, List workspace pull requests for a user, which returns pull requests authored by the specified user in a given workspace. This new operation works the same way as the deprecated endpoint but requires the {workspace}
path parameter.
API consumers must migrate their usage to the new endpoint before Feb 20, 2025.
To retrieve pull requests authored by a given user across multiple workspaces, follow these steps:
Get the list of available workspaces using the List workspaces for user operation.
Iterate over the list of workspaces and use the List workspace pull requests for a user operation to get requests authored by the user in each workspace.
If you’re using GitKraken Desktop with Bitbucket Cloud repos, you should update to version 10.6.3 or later. Previous versions were making use of the deprecated endpoint, and will stop working correctly as of Feb 20, 2025.
We are removing mirrors of third-party packages such as maven-central from packages.atlassian.com
We're updating how we provide packages for customers and partners to develop with our platforms. Starting February 1, 2025, we will discontinue providing third-party packages on packages.atlassian.com. Instead, customers and partners must fetch these packages directly from the original upstream repositories.
For details on how this change affects you and for guidance on migration, please refer to the documentation available on Atlassian Developer .
The read:user:bitbucket
Forge app scope has been removed from the following API endpoints since it is considered unnecessary. This is a non-breaking change and Forge app developers have the option of removing the read:user:bitbucket
Forge app scope from apps that use the following endpoints.
Route | Before | After |
---|---|---|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
GET |
|
|
The following API endpoints have been updated to no longer require the read:user:bitbucket
Forge app scope:
We've introduced the bitbucket:repoCodeOverviewPanel
Forge module. This module adds an expandable panel on the Source
page of a repository to display custom information defined in a Forge App.
This enhancement allows developers to customize the information displayed in the repository Source
page, improving the visibility of critical data. For more information, see Bitbucket code overview panel.
The environment key is now included in the URLs for the following modules:
Note: You will need to update any bookmarks or saved links to these pages to view your Forge app in the left navigation.
For example, for repoMainMenuPage the URL path is changing per below:
from: /{workspaceSlug}/{repositorySlug}/forge/{forgeAppId}/{forgeAppModuleKey}
to: /{workspaceSlug}/{repositorySlug}/forge/{forgeAppId}/{forgeEnvironmentKey}/{forgeAppModuleKey}
The page loaded directly with the old URL will no longer have menu items on the left navigation:
To navigate to the new URL:
Select the breadcrumb link (test_repo1 in the screenshot above) to load the repo page.
Select the menu item for the Forge page on the left navigation.
All your apps will now be listed on the left navigation.
We've introduced the bitbucket:repoPullRequestOverviewPanel
Forge module. This module adds an expandable panel on the PR Overview tab to display custom information defined in a Forge App.
This enhancement allows developers to customize the information displayed in pull request overviews, improving the visibility of critical data. For more information, see Bitbucket pull request overview panel.
The AdfRenderer component provides a way to render a valid ADF document, using the same renderer that Atlassian uses internally to render ADF content in Confluence pages, Jira work items, and so on. See ADF renderer for the full docs.
The ADF renderer component also allows you to replace node types that are unsupported in the context of a Forge app with replacement content, or remove them entirely.
See Atlassian Document Format for information on valid nodes.
Run npm i @forge/react@latest
to install the preview version of the components and try them out now.
Rate this page: