Last updated Sep 19, 2023

Part 1: Build a Bitbucket hello world app

This tutorial will walk you through creating a sample Forge app for Bitbucket. There are three parts to the tutorial:

  1. This page: describes creating, changing, and installing a simple hello world app. The focus is on learning the CLI commands needed to work with apps.
  2. Call a Bitbucket API: describes how to make API calls to the Bitbucket REST API.
  3. Change the frontend with UI Kit: describes how to use UI Kit components.

We recommend you work through all three parts to get a good understanding of how to develop apps with Forge.

Before you begin

To complete this tutorial, you need to do complete Getting started before working through this page.

Set up a shared team workspace

For Bitbucket apps you need to join or create a shared Bitbucket team workspace (as Forge apps are not supported on personal workspaces). If you don't have a Bitbucket workspace, see the references below for related instructions:

  1. Creating a Bitbucket Cloud account.
  2. Join or create a workspace.

A free Bitbucket team space can have up to 5 users.

Create your app

Create an app based on the Bitbucket repository code overview card template. You can view the completed app code in the Bitbucket Forge Hello World repository.

When you create a new app, Forge will prompt you to set a default environment. In this tutorial we use the development environment as our default. Learn more about staging and production environments.

  1. Navigate to the directory where you want to create the app. A new subdirectory with the app’s name will be created there.

  2. Create your app by running:

    forge create
  3. Enter a name for your app (up to 50 characters). For example, hello-world-app.

  4. Select the UI Kit category.

  5. Select the Bitbucket product.

  6. Select the bitbucket-repository-code-overview-card template.

  7. Change to the app subdirectory to see the app files:

    cd hello-world-app

bitbucket-repository-code-overview-card template

The app we'll create will display a card panel on all Bitbucket repository source pages and will have a function that provides the contents of the panel.

The bitbucket-repository-code-overview-card template uses Node.js and has the following structure:

├── manifest.yml
├── package-lock.json
├── package.json
└── src
    ├── frontend
    │   └── index.jsx
    ├── index.js
    └── resolvers
        └── index.js

Let’s have a look at what these files are:

You can manage, monitor and distribute your apps in the developer console.

Change the panel title

This app displays content in a Bitbucket repository card panel using the bitbucket:repoCodeOverviewCard module. Bitbucket shows the title of the bitbucket:repoCodeOverviewCard as the panel's heading. Let's change the title to include your name.

  1. In the app’s top-level directory, open the manifest.yml file.
  2. Find the title entry under the bitbucket:repoCodeOverviewCard module.
  3. Change the value of title to Forge app for <your name>. For example, Forge app for Mia.

Your manifest.yml file should look like the following, with your values for the title and app ID:

    - key: hello-world-app-hello-world-repository-code-overview-card
      resource: main
        function: resolver
      render: native
      title: Forge app for Mia
    - key: resolver
      handler: index.handler
  - key: main
    path: src/frontend/index.jsx
  id: '<your app id>'

Install your app

To use your app, it must be installed onto a Bitbucket workspace. The forge deploy command builds, compiles, and deploys your code; it'll also report any compilation errors. The forge install command then installs the deployed app onto a Bitbucket workspace with the required API access.

You must run the forge deploy command before forge install because an installation links your deployed app to a Bitbucket workspace.

  1. Navigate to the app's top-level directory and deploy your app by running:

    forge deploy
  2. Install your app by running:

    forge install
  3. Select Bitbucket using the arrow keys and press the enter key.

  4. Enter the URL for your workspace. For example,

Forge apps are not supported on personal workspaces. If you install an app to a personal workspace, you will get an insufficient permissions error. See set up a shared team workspace.

Once the successful installation message appears, your app is installed and ready to use on the specified workspace. You can always delete your app from the workspace by running the forge uninstall command.

Running the forge install command only installs your app onto the selected product. To install onto multiple products, repeat these steps again, selecting another product each time. Note that the Atlassian Marketplace does not support cross-product apps yet.

You must run forge deploy before running forge install in any of the Forge environments.

View your app

With your app installed, it’s time to see the app on a repository.

  1. Create a new Bitbucket repository if you haven't already. See Creating a repository for more information.
  2. Navigate to the source page in the repository. Your app should appear in the bottom of the Repository details pane on the right:

The app displayed in a Bitbucket repository

  1. To view new changes in your app, run forge deploy again, or run forge tunnel. This is explained fully in the next section.

While your app is deployed to either a development or staging environment, (development) or (staging) will appear in your app title. This suffix is removed once you've deployed your app to production.

Deploy app changes

Once your app is installed, it will automatically pick up all minor app deployments so you don't need to run the forge install command again. Minor deployments are changes that don't modify app permissions in the manifest.yml file. You can deploy the changes onto your developer site or Bitbucket workspace by using one of two methods:

  • Manually, by running the forge deploy command.
  • Automatically, by running the forge tunnel command.

Once your app is installed, changes in the manifest are picked up automatically after running forge deploy. However, due to the eventually-consistent nature of our system, you may need to wait up to 5 minutes for changes in the manifest to be reflected in the product.

Tunneling runs your app code locally on your machine via the Forge CLI and ngrok. It allows you to speed up development by avoiding the need to redeploy each code change, and by seeing each invocation as it executes. The Forge tunnel works similarly to hot reloading, so any changes you make to your app code can be viewed on your Atlassian site or Bitbucket workspace without losing the current app state. You don’t need to run any other commands; you only need to refresh the page.

To use the forge tunnel command, Docker must be set up and running. To learn about Docker, visit the Docker getting started guides.

If you don't want to run Docker, you can redeploy your app after each code change with the forge deploy command. You will also need to modify the manifest.yml file to specify a runtime for the app field:

  id: <your app id>
    name: nodejs18.x
  1. Once Docker is set up, you can start tunneling by running:
forge tunnel

You should see output similar to:

Running your app locally with Docker. The tunnel displays your usage from everywhere
the app in the development environment is installed.
Press Ctrl+C to cancel.

Checking Docker image... 100%
Your Docker image is up to date.

Listening for requests on local port 37363...

Reloading code...
App code reloaded.

You can now automatically deploy changes to your codebase and install packages, while tunneling. These changes appear on the Atlassian site or Bitbucket workspace where your app is installed.

  1. When you are ready to close the tunnel, press Control + C.

The forge tunnel command only forwards traffic when the user (in Jira, Confluence, Jira Service Management, or Bitbucket) matches the Forge CLI user. For security reasons, you can’t see the traffic of other users.

For important caveats on how forge tunnel works, see Tunneling.

Next step

In the next tutorial, you'll learn how to make API calls to Bitbucket using Forge. This tutorial uses the forge tunnel, so make sure you are familiar with using this command.

A button to go to the next tutorial

Rate this page: