jira插件开发

看到现在最重要的教程
http://jiradev.com/tutorials.html

写的很详细的教程

活动对象入门(Active Objects)

工作流(workflow)

api文档(请选择对应版本)
7.1.0

7.6.1

插件模块类型说明1

插件模块类型说明2

atlas命令说明

常用命令

atlas-create-jira-plugin:创建一个新的JIRA插件框架

atlas-create-jira-plugin-module:为您提供可供选择的模块列表。自动将您的选择添加到插件定义文件。

atlas-run:启动JIRA实例,可用于测试插件。

atlas-debug:启动JIRA实例,可用于在调试模式下测试插件。您可以使用IDE的远程调试器来连接和调试代码。

atlas-cli:当您使用atlas-run或atlas-debug启动JIRA实例时,对代码进行了更改,则必须重新部署插件以包含所做的更改。atlas-cli命令与“ pi”命令(插件安装)一起使用,可将插件重新部署到正在运行的JIRA实例上。

atlas-clean:使用atlas-run或atlas-debug启动JIRA实例时,您会注意到在插件目录中创建了一个名为“ target”的新文件夹。atlas-clean删除了该目录。您将丢失用于测试的实例上的所有数据。

atlas-package:创建可用于在JIRA实例上部署的jar。

1.设置JAVA _ HOME并更新Path变量

添加变量JAVA_HOME,指向JDK1.8安装路径
jira插件开发_第1张图片
在cmd中输入java -version查看是否安装成功
在这里插入图片描述

2.安装SDK

根据官方网址下载最新SDK文件
https://developer.atlassian.com/docs/getting-started/set-up-the-atlassian-plugin-sdk-and-build-a-project/install-the-atlassian-sdk-on-a-windows-system

双击安装

查看环境变量,自动添加了

ATLAS_HOME
C:\Applications\Atlassian\atlassian-plugin-sdk-8.0.16
path:C:\Applications\Atlassian\atlassian-plugin-sdk-8.0.16\bin

在cmd中输入atlas-version查看是否安装成功
jira插件开发_第2张图片

3.使用Atlassian SDK创建项目

打开需要创建插件的文件夹,打开cmd命令提示符窗口中的atlas-create-jira-plugin 命令 创建一个附加项目 :

atlas-create-jira-plugin

jira插件开发_第3张图片

系统将提示您提供有关插件的一些信息。就本教程而言,请对提示进行如下响应:

Define value for groupId: : com.atlassian.tutorial
Define value for artifactId: : myPlugin
Define value for version: 1.0.0-SNAPSHOT: : 1.0.0-SNAPSHOT
Define value for package: com.atlassian.tutorial: : com.atlassian.tutorial.myPlugin

注意:电脑中原来安装的maven可能会影响创建新的项目,我在创建项目时,提示no dependency information available,发现是sdk下的maven读取了C:\Users\Administrator.m2\setting.xml配置文件,删除该配置文件之后可以正常创建

plugin默认文件架构如下

.
├── LICENSE
├── README
├── pom.xml
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── atlassian
    │   │           └── tutorial
    │   │               └── myPlugin
    │   │                   ├── api
    │   │                   │   └── MyPluginComponent.java
    │   │                   └── impl
    │   │                       └── MyPluginComponentImpl.java
    │   └── resources
    │       ├── META-INF
    │       │   └── spring
    │       │       └── plugin-context.xml
    │       ├── atlassian-plugin.xml
    │       ├── css
    │       │   └── myPlugin.css
    │       ├── images
    │       │   ├── pluginIcon.png
    │       │   └── pluginLogo.png
    │       ├── myPlugin.properties
    │       └── js
    │           └── myPlugin.js
    └── test
        ├── java
        │   ├── it
        │   │   └── com
        │   │       └── atlassian
        │   │           └── tutorial
        │   │               └── myPlugin
        │   │                   └── MyComponentWiredTest.java
        │   └── ut
        │       └── com
        │           └── atlassian
        │               └── tutorial
        │                   └── myPlugin
        │                       └── MyComponentUnitTest.java
        └── resources
            └── atlassian-plugin.xml

4.启动JIRA插件

进入插件项目根目录下,打开cmd命令提示符窗口输入:

 atlas-run

第一次执行此操作时,可能需要几分钟才能完成。

打开浏览器窗口,然后跳转到
localhost:2990 / jira.

用户名: admin
密码: admin

将出现“欢迎”对话框,并要求您配置一些基本的JIRA设置。

可以单击屏幕顶部的齿轮图标以打开管理对话框,然后选择“加载项” ,最后在“ Atlassian Marketplace管理”页面打开时,在右侧选择“ 管理应用” 。
jira插件开发_第4张图片

在命令提示符窗口使用CTRL + D或CTRL + C正常关闭JIRA

5.修改插件

关闭JIRA后,您仍应位于myPlugin目录中。
在您喜欢的编辑器中打开pom.xml文件。
在文件中找到< organization >元素。它看起来应该像这样:

<organization>
    <name>Example Companyname>
    <url>http://www.example.com/url>
organization>

更新为插件基本信息,例如:

<organization>
    <name>Atlassian SDK Tutorialname>
    <url>http://developer.atlassian.com/url>
organization>

保存并关闭文件。

6.向JIRA添加自定义菜单

/src/main/resources/atlassian-plugin.xml是自定义菜单配置文件
可以通过执行项目根目录下的命令提示符窗口中执行

atlas-create-jira-plugin-module

进行编辑

系统将提示您从可能的模块类型列表中选择一个插件模块
jira插件开发_第5张图片
修改后的atlassian-plugin.xml示例

<atlassian-plugin key="${atlassian.plugin.key}" 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.pngparam>
<param name="plugin-logo">images/pluginLogo.pngparam>
plugin-info>
 
<resource type="i18n" name="i18n" location="jiraDemo"/>
 
<web-resource key="jiraDemo-resources" name="jiraDemo Web Resources">
<dependency>com.atlassian.auiplugin:ajsdependency>
<resource type="download" name="jiraDemo.css" location="/css/jiraDemo.css"/>
<resource type="download" name="jiraDemo.js" location="/js/jiraDemo.js"/>
<resource type="download" name="images/" location="/images"/>
<context>jiraDemocontext>
web-resource>
<web-section name="mySection" i18n-name-key="my-section.name" key="my-section" location="my-item-link" weight="1000">
<description key="my-section.description">The mySection Plugindescription>
<label key="my-section.label"/>
web-section>
<web-item name="myItem" i18n-name-key="my-item.name" key="my-item" section="system.top.navigation.bar" weight="1000">
<description key="my-item.description">The myItem Plugindescription>
<label key="my-item.label"/>
<link linkId="my-item-link">deleteMelink>
web-item>
atlassian-plugin>

在atlas run的状态下,打包指令对插件进行更新执行热部署

atlas-package

7.

你可能感兴趣的:(jira,jira)