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 pull request action (EAP)

The bitbucket:repoPullRequestAction module adds a menu item in the more actions (•••) menu on the pull request page. When the menu item is clicked, the module’s function renders a modal dialog.

Example of a repository pull request action

An example of the triggered modal dialog:

Example of a repository pull request action dialog

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 action, which is displayed as a menu item.
`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 modal dialog opened by the action menu item.
`resource`	`string`		A reference to the static `resources` entry that your modal dialog 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.

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 action menu item is displayed in.
`repository.uuid`	`string`	The repository UUID which will be wrapped in `{}`.
`pullRequest`	`object`	The pull request where this action menu item is displayed on.
`pullRequest.id`	`integer`	The pull request id.

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 action menu item is displayed in.
`repository.uuid`	`string`	The repository UUID which will be wrapped in `{}`.
`pullRequest`	`object`	The pull request where this action menu item is displayed on.
`pullRequest.id`	`integer`	The pull request id.

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.