Repository pull request action

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`	Required if using custom UI or the latest version of UI Kit.	A reference to the static `resources` entry that your context menu app wants to display. See resources for more details.
`render`	`'native'`	Yes for UI Kit.	Indicates the module uses UI Kit.
`resolver`	`{ function: string }` or `{ endpoint: string }`	Yes	Set the `function` property if you are using a hosted `function` module for your resolver. Set the `endpoint` property if you are using Forge remote (preview) to integrate with a remote back end.

Extension context

UI Kit and Custom UI

Use the useProductContext hook to access the extension context in UI Kit or getContext bridge method 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.

Some Forge APIs (for example, storage API) do not support {}. You can use the unwrapUUid and wrapUuid functions to convert a Bitbucket resource ID between a wrapped and unwrapped UUID. See unwrapUuid/wrapUuid helper functions for more information.

UI Kit 1

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

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.