Rate this page:
This tutorial walks through creating a Forge app to display content on a Jira issue.
Complete Getting started before working through this page.
Create an app based on the Jira issue panel template.
Note, Forge provides multiple environments where you deploy the app. This tutorial uses the CLI default, the environment. See Environments to learn more.
Create your app by running:
Change to the app subdirectory to see the app files.
The jira-issue-panel template uses Node.js and has the following structure:
1 2 3 4 5 6 7
hello-world-app |-- src | `-- index.jsx |-- manifest.yml |-- package.json |-- package-lock.json `-- README.md
Let’s have a look at what these files are:
This app displays content in a Jira issue panel using the module. Jira shows the title of the as the panel's heading. Let's change the title to include your name.
Your file should look like the following, with your values for the title and app ID.
1 2 3 4 5 6 7 8 9 10 11 12
modules: 'jira:issuePanel': - key: hello-world-app-hello-world-panel function: main title: Forge app for Mia icon: https://developer.atlassian.com/platform/forge/images/issue-panel-icon.svg function: - key: main handler: index.run app: id: '<your app id>' name: hello-world-app
Any time you make changes to the code, deploy your app using the command. This command builds, compiles, and deploys your code, and reports any compilation errors.
To install your app on a new site, run the command. Once the app is installed on a site, it will automatically pick up all minor app deployments, which means you don't need to run the install command again. A minor deployment includes any change that doesn't modify app permissions in the manifest.
In the Forge environment, your app is deployed with all available OAuth scopes. Later in this tutorial, you’ll learn how to restrict your app to request just the access it needs.
Navigate to the app's top-level directory and deploy your app by running:
Install your app by running:
Select your Atlassian product using the arrow keys and press the enter key.
Note: Running the command only installs your app onto the selected product. To install onto multiple products, repeat these steps again, selecting another product each time.
Enter the URL for your development site. For example, example.atlassian.net.
Once the successful installation message appears, your app is installed and ready to use on the specified site.
Note, you need to run before running in any of the Forge environments.
With your app installed, it’s time to see the app on an issue.
The app is shown in an issue panel after clicking the Forge app for Mia button. Once expanded, the app displays on the page, like the example below.
Note, while your app is deployed to either a development or staging environment, or will appear in your app title. This suffix is removed once you've deployed your app to production.
See Part 2: Call a Jira API to learn how to make API calls to Jira with Forge.
Rate this page: