您的位置：首页 > 其它

创建jira插件

2015-10-26 18:44 453 查看

准备环境、安装SDK
https://developer.atlassian.com/docs/getting-started/set-up-the-atlassian-plugin-sdk-and-build-a-project/install-the-atlassian-sdk-on-a-linux-or-mac-system
编写插件
https://developer.atlassian.com/docs/getting-started/set-up-the-atlassian-plugin-sdk-and-build-a-project/create-a-helloworld-plugin-project

Create a HelloWorld Plugin Project

At this point, you have set up your environment and run a test with a standalone version of JIRA. In this section, you learn how to create a plugin module. For now, you are just going to use the command line tools. Later, you'll learn how to run the tools from an IDE. This page contains the following sections:

Step 1: Create your first project

If you haven't already done so, go ahead and open a terminal window and then do the following:

Change directory to the

atlastutorial

folder you created earlier at the root of your home directory.

Once you are in the folder, enter the

atlas-create-jira-plugin

command to create the plugin.

1

atlas-create-jira-plugin

The command prompts you for the JIRA version.

Enter

for

JIRA 5

and press RETURN.
The command prompts you for the basic information each plugin needs.

Respond to the prompts using the information in the following table:

Define value for groupId	com.atlassian.tutorial
Define value for artifactId	helloworld
Define value for version	1.0-SNAPSHOT
Define value for package	com.atlassian.tutorial.helloworld

The system prompts you to confirm the configuration you entered:

1

Confirm properties configuration:

groupId: com.atlassian.tutorial

artifactId: helloworld

version: 1.0-SNAPSHOT

package: com.atlassian.tutorial.helloworld

Press

to continue.
The system creates a

helloworld

project folder. This initial project folder contains the basic skeleton of a plugin.

Step 2: Examine the contents of the plugin skeleton

With a single command, you have a skeleton plugin project containing the following source:

Contents	Description
LICENSE	A placeholder for a license file.
README	Simple hints for running the atlas- commands.
pom.xml	Maven configuration file for your project.
src	The generated source for the plugin.

Take a closer look at the code created for you in the

src

directory. The

src/test/java

contains a generated class and some placeholders for testing your plugin. You'll learn more about this later. The

src/main

folder contains an initial

/com/atlassian/tutorial/helloworld/MyPluginComponent.java

file and a

/com/atlassian/tutorial/helloworld/MyPluginComponentImpl.java

. The

src/main/resources

folder contains a single

atlassian-plugin.xml

file — this file is the descriptor. It defines the plugin modules your plugin uses.

At this point, your descriptor file should not define any modules. Let's test this, by looking in the descriptor file:

Open your favorite text editor.

Browse to and open the

atlastutorial/helloworld/src/main/resources/atlassian-plugin.xml

file.
At this point the contents of the file should look like this:

1

<atlassian-plugin key="${project.groupId}.${project.artifactId}" name="${project.name}" plugins-version="2">

<plugin-info>

<description>${project.description}</description>

<version>${project.version}</version>

<vendor name="${project.organization.name}" url="${project.organization.url}" />

<param name="plugin-icon">images/pluginIcon.png</param>

<param name="plugin-logo">images/pluginLogo.png</param>

</plugin-info>

<!-- add our i18n resource -->

<resource type="i18n" name="i18n" location="helloworld"/>

<!-- add our web resources -->

<web-resource key="helloworld-resources" name="helloworld Web Resources">

<dependency>com.atlassian.auiplugin:ajs</dependency>

<resource type="download" name="helloworld.css" location="/css/helloworld.css"/>

<resource type="download" name="helloworld.js" location="/js/helloworld.js"/>

<resource type="download" name="images/" location="/images"/>

<context>helloworld</context>

</web-resource>

<!-- publish our component -->

<component key="myPluginComponent" class="com.atlassian.tutorial.helloworld.MyPluginComponentImpl" public="true">

<interface>com.atlassian.tutorial.helloworld.MyPluginComponent</interface>

</component>

<!-- import from the product container -->

<component-import key="applicationProperties" interface="com.atlassian.sal.api.ApplicationProperties" />

</atlassian-plugin>

Several of the entries in the

<plugin-info>

should look familiar. If you recall, the

atlas-create-jira-plugin

command asked you for a

groupId

and an

artifactId

. These values landed in another file all together.

Your plugin includes resources that allow you to control look and feel. These appear under the web resources section. You'll learn more about these in another tutorial. For now, focus on the relatively simple

<plugin-info>

section.

Close the

atlassian-plugin.xml

file.

Open the

atlastutorial/helloworld/pom.xml

.
This file is a Maven project object model file. This file contains project and dependency information that Maven uses to build your plugin. This tutorial isn't going into the finer points of Maven or its files.

Search for the

artifactId

value.
You should find the

artifactId

you entered when you created the skeleton. The

project.artifactId

you saw in the

atlassian-plugin.xml

file references this value.

Familiarize yourself with the file a bit by looking for other values you entered through the command such as the

groupId

and

version

.

Close the file when you are done.

Step 3: Load the helloworld plugin into JIRA

Even though you haven't written any code, you can still load the skeleton plugin into JIRA. When you load a plugin into JIRA, it is visible in the Universal Plugin Manager (UPM). The UPM is in every Atlassian application. It allows you to install, view, and update plugins in your host application. The host application in this case is JIRA. You load a plugin using the

atlas-run

command. Try this command and see what happens:

Open a command line (DOS prompt for Windows users).

Change directory to the root of your plugin project.

1

cd atlastutorial/helloworld

Enter the

atlas-run

command.
The command creates a

target

sub directory under your project root. You will examine this directory a bit more later. When the command completes successfully, you'll see some output that looks very similar to the output of the

atlas-run-standalone

command.

1

[WARNING] [talledLocalContainer] INFO: Deploying web application archive cargocpc.war

[WARNING] [talledLocalContainer] May 9, 2012 8:15:56 AM org.apache.coyote.http11.Http11Protocol star

[WARNING] [talledLocalContainer] INFO: Starting Coyote HTTP/1.1 on http-2990

[WARNING] [talledLocalContainer] May 9, 2012 8:15:56 AM org.apache.jk.common.ChannelSocket init

[WARNING] [talledLocalContainer] INFO: JK: ajp13 listening on /0.0.0.0:8009

[WARNING] [talledLocalContainer] May 9, 2012 8:15:56 AM org.apache.jk.server.JkMain start

[WARNING] [talledLocalContainer] INFO: Jk running ID=0 time=0/130  config=null

[WARNING] [talledLocalContainer] May 9, 2012 8:15:56 AM org.apache.catalina.startup.Catalina start

[WARNING] [talledLocalContainer] INFO: Server startup in 100008 ms

[INFO] [talledLocalContainer] 2012-05-09 08:15:59,176 QuartzWorker-0 INFO ServiceRunnerBackup Se

rvice [jira.bc.dataimport.DefaultExportService] Data export completed in 781ms. Wrote 622 entities t

o export in memory.

[INFO] [talledLocalContainer] 2012-05-09 08:15:59,186 QuartzWorker-0 INFO ServiceRunnerBackup Se

rvice [jira.bc.dataimport.DefaultExportService] Attempting to save the Active Objects Backup

[INFO] [talledLocalContainer] 2012-05-09 08:15:59,487 QuartzWorker-0 INFO ServiceRunnerBackup Se

rvice [jira.bc.dataimport.DefaultExportService] Finished saving the Active Objects Backup

[INFO] [talledLocalContainer] Tomcat 6.x started on port [2990]

[INFO] jira started successfully in 161s at http://manthony-PC:2990/jira[/code]
20

[INFO] Type Ctrl-D to shutdown gracefully

[INFO] Type Ctrl-C to exit

Open your browser and log into the JIRA instance.
(Remember, the username and password are both admin
.)

Select the

cog (Administration) icon in the right corner.

Choose Add-ons from the menu.
The system places you on the Administration page.

Choose Manage Add-ons from the left-hand menu.
The system opens the Manage Add-ons page.

Locate the helloworld plugin listings in User-installed Add-ons category.
You'll find two listings for your plugin. One for the plugin itself and one for the plugin tests.

Expand each entry by click it.
You should see the following for the plugin alone:

The plugin has just the basic modules that you get for "free" when you create a plugin. These modules don't do much yet.

Close the JIRA browser window.

Return to the terminal window where you started atlas-run
and shutdown the process with CTRL-D
.

Step 4: Make a change and see it reflected in the application
In this step, you'll make a small change in your plugin's pom.xml
file. Then, you'll rebuild your plugin with the atlas-run
command.

Open the pom.xml
file in your favorite editor.

Locate the <organization>
element.

Update the element to look like the following:

<name>HelloGoodby Inc.</name>

<url>http://www.helloworldgoodbye.com/</url>

</organization>

Save and close the file.

Run the atlas-run
command in the terminal window.

Open the plugins page in your browser using the following path http://localhost:2990/jira/plugins/servlet/upm#manage.
JIRA still prompts you for the username/password.

Expand the helloworld plugin to see your changes.

The Next Steps
So far, you've used the SDK from a command line. However, most programmers working in complex code prefer the help of an integrated development environment (IDE). One of the most popular IDE is Eclipse. In the next section, you install and configure the Eclipse IDE on Windows orfor Linux/Mac. If you are using IntelliJ, please see this page.

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航