Example apps for Bitbucket

Before you begin exploring these example apps, you'll need to set up the Forge CLI first. Learn more about getting started.

Once the Forge CLI is up and running, clone an example app repository to explore and customize it locally. Each repository's README.md file contains quickstart instructions and other details about the app.

For more information, refer to our getting started guides for building Bitbucket, Confluence, Jira, and Jira Service Management apps. Our tutorials and guides also offer useful information for common tasks.

Related pull requests app

This app adds a pull request card that displays pull requests related to the one you're viewing, based on the Jira tickets mentioned in the title of the current pull request.

• Code: Related pull request app
• Products: Bitbucket
• Modules: bitbucket:repoPullRequestCard
• Custom UI: none
• UI Kit:
  • DynamicTable, Link, Lozenge, and Text components
• Other use-cases:
  • Calls the Bitbucket REST API with asApp to retrieve relevant pull requests using BBQL (using route as well as routeFromAbsolute).

To try this app out, you can install it into your workspace.

Repository metadata audit log

This app adds a repository settings page that displays metadata changes to your repository. To capture changes to the repository, it subscribes to the Bitbucket repository updated event.

• Code: Repository metadata audit log
• Products: Bitbucket
• Modules: bitbucket:repoSettingsMenuPage, trigger
• Events: avi:bitbucket:updated:repository
• Custom UI: none
• UI Kit:
  • Code, DynamicTable, Inline, Spinner, Strong, Text, and User components
• Other use-cases:
  • Uses Forge hosted storage to store repository metadata changelog entries.

To try this app out, you can install it into your workspace.

Classic merge checks as custom merge checks

This app implements Bitbucket's classic merge checks as custom merge checks. It uses a repository settings page to configure merge check conditions.

• Code: Bitbucket official merge checks
• Products: Bitbucket
• Modules:: bitbucket:mergeCheck, bitbucket:repoSettingsMenuPage
• Custom UI: none
• UI Kit:
  • Box, ErrorMessage, Form, FormFooter, FormHeader, FormSection, Inline, Label, LoadingButton, RequiredAsterisk, SectionMessage, Spinner, Strong, Text, and Textfield components
• Other use-cases:
  • Calls the Bitbucket REST API with asApp to retrieve data required to evaluate merge checks.
  • Uses Forge hosted storage to store the check configuration for each repository.

To try this app out, you can install it into your workspace.

Pull request title validator with custom merge checks

This app creates a custom merge check that can block a pull request from being merged if the title does not contain a string configured in the repository settings page.

• Code: Pull request title validator
• Products: Bitbucket
• Modules:: bitbucket:mergeCheck, bitbucket:repoSettingsMenuPage
• Custom UI: none
• UI Kit:
  • ErrorMessage, Form, FormFooter, Inline, Label, LoadingButton, RequiredAsterisk, Spinner, Text, and Textfield components
• Other use-cases:
  • Calls the Bitbucket REST API with asApp to retrieve the pull request the check was invoked for.
  • Uses Forge hosted storage to configure the expected prefix.

To try this app out, you can install it into your workspace.

Pull request secrets scanner with custom merge checks

This app creates a custom merge check that can block a pull request from being merged when there are secrets detected in your repository.

• Code: Pull request secrets scanner
• Products: Bitbucket
• Modules:: bitbucket:mergeCheck
• Custom UI: none
• UI Kit: none
• Other use-cases:
  • Uses Bitbucket Security Secret Scanner pipe to detect secrets in your repository.
  • Uses the asApp method to invoke the Bitbucket REST API, retrieving the pull request associated with the initiated check.
  • Uses the asApp method to invoke the Bitbucket REST API, aiming to fetch the code insights report produced by the Bitbucket Security Secret Scanner.

To try this app out, you can install it into your workspace.

Dynamic Pipelines provider tutorial app

This app is a reference implementation of Orchestrate your builds using Dynamic Pipelines tutorial, it adds a step to the default pipeline.

• Code: Dynamic Pipelines provider tutorial app
• Products: Bitbucket
• Modules:: bitbucket:dynamicPipelinesProvider
• Custom UI: none
• UI Kit: none
• Other use-cases:
  • Uses the asApp method to invoke the Bitbucket REST API, retrieving the diff stat for a commit the pipeline is requested to run at.

To try this app out, you can install it into your workspace.