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 using 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 description: A hello world issue panel. function: - key: main handler: index.run app: id: '<your app id>' name: hello-world-app
Any time you make changes to the code you'll need to deploy your app, with the command. This command builds your code and reports any compilation errors.
Install your app, with the command, when you want to install your app on a new site. Note, once the app is installed on a site, the site picks up the new app changes you deploy without needing to run the install command again.
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 command installs your app in all available Atlassian products on the site. You don’t need to run the command for each product.
Enter the URL for your development site. For example, example.atlassian.net.
With your app installed, it’s time to see the app on an issue.
The app should display on the page like the image below.
See Part 2: Call a Jira API to learn how to make API calls to Jira with Forge.
Rate this page: