Confluence のプラグイン開発環境をつくってみる (Mac OSX)

ほぼ JIRA とかわらない手順でできます！

1. まずはプラグイン開発用の SDK をインストール

Homebrew で簡単!

$ brew tap atlassian/tap
$ brew install atlassian/tap/atlassian-plugin-sdk

2. プロジェクトの作成

1 でインストールした SDK のコマンドをつかってプロジェクトの雛形を作成する。

$ atlas-create-confluence-plugin
...
Define value for groupId: :jp.co.tagbangers
Define value for artifactId: : confluence-sample-plugin
Define value for version:  1.0.0-SNAPSHOT: :
Define value for package:  jp.co.tagbangers: 

Maven ベースの以下のような雛形でできる。

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

25 directories, 15 files

3. プロジェクトの実行

$ atlas-run

以下のようなログが表示され、開発用の Confluence がローカルで起動する。

[INFO] [talledLocalContainer] 2017-08-01 21:05:38,902 INFO [localhost-startStop-1] [confluence.admin.actions.SystemInfoOnStartup] startup
[INFO] [talledLocalContainer] --------------------------
[INFO] [talledLocalContainer] Build Information
[INFO] [talledLocalContainer] --------------------------
[INFO] [talledLocalContainer] installationDate = Tue Jun 02 11:49:31 JST 2015
[INFO] [talledLocalContainer] supportEntitlementNumber = null
[INFO] [talledLocalContainer] buildNumber = 6441
[INFO] [talledLocalContainer] serverId = BVNM-FPFQ-XPC6-70J1
[INFO] [talledLocalContainer] version = 5.10.7
[INFO] [talledLocalContainer] home = /path/to/confluence-sample-plugin/target/confluence/home
[INFO] [talledLocalContainer] upTime = 49 seconds
[INFO] [talledLocalContainer] baseUrl = http://localhost:1990/confluence
[INFO] [talledLocalContainer] devMode = true

起動したら http://localhost:1990/confluence にアクセス!

ちなみに開発用の Confluence は Username: admin / Password: admin でログインできます!

これでプラグイン開発の準備は OK。