Creating a “Hello World” plugin for Jira Cloud

Here are detailed step-by-step instructions for creating a “Hello World” plugin for Jira Cloud:

Step 1: Install Prerequisites

  • Java Development Kit (JDK):

Download JDK: Visit the Oracle website or adopt OpenJDK to download and install the Java Development Kit (JDK).

Oracle JDK: Oracle JDK Downloads

Adopt OpenJDK: Adopt OpenJDK

Install JDK: Follow the installation instructions for your operating system.

  • Apache Maven:

Download Maven: Visit the Apache Maven website to download Maven.

Apache Maven Downloads

Install Maven: Follow the installation instructions for your operating system.

Step 2: Set Up the Atlassian Plugin SDK

Atlassian Connect Express (ACE):

Install Atlassian Connect Express (ACE): ACE is a tool for developing Atlassian Connect add-ons.

npm install -g atlassian-connect

Create a New Connect Add-on Project:

atlas-connect new

 

 

 

Step 3: Navigate to the Project Directory

cd your-plugin-directory

 

 

 

Step 4: Modify atlassian-connect.json

Open the atlassian-connect.json file in a text editor and add the following module:

“modules”: {

 “generalPages”: [

   {

     “key”: “hello-world-page”,

     “location”: “system.top.navigation.bar”,

     “name”: {

       “value”: “Hello World Page”

     },

     “url”: “/hello-world”,

     “conditions”: [

       {

         “condition”: “user_is_logged_in”

       }

     ]

   }

 ]

}

Step 5: Create a Hello World Page

Create a new file hello-world.hbs in the views directory with the following content:

html

Copy code

<!DOCTYPE html>

<html>

<head>

   <title>Hello World Page</title>

</head>

<body>

   <h1>Hello, World!</h1>

</body>

</html>

Step 6: Start the Local Development Server

atlas-connect express

Step 7: Install the Plugin in Jira Cloud

·       Open your Jira Cloud instance.

·       Navigate to “Jira Settings” > “Apps” > “Manage Apps.”

·       Click on “Settings” > “Manage Apps” > “Upload app” and upload your add-on from the URL https://localhost:3000/atlassian-connect.json.

Step 8: Test Your Plugin

After installation, navigate to the “Hello World Page” from the top navigation bar in Jira.

Congratulations! You have successfully created a simple “Hello World” plugin for Jira Cloud. Customize and extend it further based on your needs.

Leave a comment

Your email address will not be published. Required fields are marked *