We are releasing a limited set of Bitbucket modules, events, and APIs under Forge's Early Access Program (EAP). This will allow you to start building Bitbucket apps through the Forge platform.

For more information about this EAP, see the related changelog entry here.

Forge’s EAP offers experimental features to selected users for testing and feedback purposes. These features are not supported or recommended for use in production environments. They are also subject to change without notice.

For more information, see Forge EAP, Preview, and GA.

Repository overview card (EAP)

The bitbucket:repoCodeOverviewCard module adds a card on the right hand sidebar of the repository source page.

Example of an repository code overview card

Properties

Property	Type	Required	Description
`key`	`string`	Yes	A key for the module, which other modules can refer to. Must be unique within the manifest. Regex: `^[a-zA-Z0-9_-]+$`
`title`	`string`	Yes	The title of the card which is displayed.
`function`	`string`	This module requires a `function` for use with the UI kit or a `resource` when building with custom UI.	A reference to the `function` module that defines the repository code overview card.
`resource`	`string`		A reference to the static `resources` entry that your card wants to display. See resources for more details.
`render`	`'native'`	Yes for UI Kit 2	Indicates if the module is a UI Kit 2 module.
`resolver`	`{ function: string }`	No	Contains a `function` property, which references the `function` module that defines the configuration of `resource`. Can only be set if the module is using the `resource` property.
`icon`	`string`		The icon displayed next to the `title`. For custom UI and UI kit apps, the `icon` property accepts a relative path from a declared resource. Alternatively, you can also use an absolute URL to a self-hosted icon. See Icons for more information. If no icon is provided, or if there's an issue preventing the icon from loading, a generic app icon will be displayed.

Extension context

Custom UI

Use the getContext bridge method to access the extension context in custom UI.

Property	Type	Description
`type`	`string`	The type of the module.
`repository`	`object`	The repository where this card is displayed in.
`repository.uuid`	`string`	Repository UUID which will be wrapped in `{}`.

UI kit

Use the useProductContext hook to access the context in UI Kit.

Property	Type	Description
`type`	`string`	The type of the module.
`repository`	`object`	The repository where this card is displayed in.
`repository.uuid`	`string`	Repository UUID which will be wrapped in `{}`.

UI kit 2

This module now has support for UI Kit 2 (preview) for faster user experiences and to access additional React features.

For more information on all the supported modules, see the Supported products and their modules section.