AtlasCamp 2010: The Atlassian Plugin SDK For Fun & Profit - Ben Speakmon

The Atlassian Plugin SDK For Fun & Profit

Ben SpeakmonAtlassian Developer Relations

Wednesday, November 3, 2010

Agenda

• Challenges in writing plugins

• How the SDK fixes it

• SDK in action

• What’s new

• Getting involved

Plugin challengesI am yours, you are mineYou are what you areAnd you make it hard

--”Suite: Judy Blue Eyes”, Crosby, Stills & Nash

Effective plugin development

• Different than product development

• Work within someone else’s sandbox

• Three things that MUST be easy:

• Starting the product

• Configuring the product

• Installing the plugin

Challenge #1: StartingProduct Startup method

JIRA bin/startup.sh or .bat (standalone) or WAR install into app. server

Confluence bin/startup.sh or .bat (standalone) or WAR install into app. server

Bamboo bamboo.sh or Win32 service or WAR install into app. server

Crowd start_crowd.sh or .bat (standalone) or WAR install into app. server

FishEye/Crucible run.sh or .bat – no WAR version available

Challenge #2: ConfigProduct Data/logs dir. Configuration

JIRA jira-home WEB-INF/classes/jira-application.properties

Confluence None by defaultWEB-INF/classes/confluence-

init.properties

Bamboo None by defaultWEB-INF/classes/bamboo-

init.properties

Crowd None by defaultWEB-INF/classes/crowd-

init.properties, system / servlet context property

FishEye/Crucible

var FISHEYE_INST environment variable

Challenge #3: Plugin install

Product Install methods

JIRA Two plugin directories for different plugin systems, web interface

Confluence Two plugin directories for different plugin systems, web interface, plugin repository

Bamboo Two plugin directories for different plugin systems, web interface

Crowd One plugin directory (plugins 2 only)

FishEye/Crucible One plugin directory (plugins 2 only)

And if that wasn’t enough...

• Build systems

• Maven 1 or 2? Ant?

• Confusing dependencies

• Starting a plugin project

• Expert product knowledge required just to get started

• Maven archetypes are too hard to use

It all adds up to...

• Lots of small headaches

• Not your fault

• Not your job to fix them

• Slow code/test/debug cycle

• Frustration

How the SDK deals with this

“What is happiness? The feeling that power is growing, that resistance is overcome.”

--Friedrich Nietzsche, LISP user

atlas-runWednesday, November 3, 2010

init.properties

FishEye/Crucible

init.properties

FishEye/Crucible

Logs sent to console, preconfigured data dirs

Automatic through atlas-run

SDK DesignA process cannot be understood by stopping it. Understanding must move with the flow of the

process, must join it and flow with it.-- First Law of Mentat

Atlassian MavenPlugin Suite

• Suite of Maven plugins

• maven-jira-plugin, maven-confluence-plugin, etc.

• Common interface to products

• Handles installation and configuration

• Can be used independently of the SDK

Script shortcutsTask Maven command Script

Start product with current plugin installed

mvn amps:run atlas-run

Start product with current plugin installed and

debuggablemvn amps:debug atlas-debug

Start JIRA on port 8243 and context “myjira” with current

plugin installed

mvn amps:run –Dproduct=jira –Dcontext.path=/myjira –Dhttp.port=8243

atlas-run--product jira--context-path /myjira--http-port 8243

Run arbitrary Maven command

mvn myplugin:mygoal <parameters>

atlas-mvn myplugin:mygoal <parameters>

SDK in actionBy pressing down a special keyIt plays a little melody

--”Pocket Calculator”, Kraftwerk

SDK with Plugins 1.0

• SDK is only at full power with plugins 2

• http://confluence.atlassian.com/x/wRyyCg for details on how

30-second Plugin Creation™

• Creating a plugin is dirt simple!

• atlas-create-<product>-plugin

• Executes a Maven archetype

• Automatically prompts for required information

• Created plugin project works out of the box

Creating a new plugin

On-the-fly code change

• Fast code/test/debug

• Start a CLI instance in a separate terminal from atlas-run

•Make a code change

• Reinstall the plugin from the CLI

CLI plugin installation

Auto resource reload

• Plugin web resources are monitored

• Detects change and auto-updates

• Just reload the browser, see your changes, get the green-skinned alien girl, repeat

Changing a live gadget

Boxed Maven• Contains a standalone,

isolated Maven 2.1.0

• Uses Atlassian repos by default

• No extra configuration needed

• Usable on its own

• atlas-mvn passes parameters and goals straight through

What’s newCome on! Stop trying to hit me and hit me!

--Morpheus, The Matrix

External home directories

• Create a zip of an existing product home directory

• atlas-run starts the product with that data/configuration/etc.

• Thanks to Jonathan Doklovic @ SysBliss!

Test groups

• Create groups of tests

• Write a group of tests for all supported products and separate groups for product-specific testing

• Run one, some, or all groups at once

Multiple version testing

• Run a test (or a test group) against multiple versions of the same product

• “Why does it work in JIRA 4.1 but not 4.2?”

Co-installs

• Your plugin may require other plugins or special artifacts to run

• SDK can install these for you during atlas-run or atlas-debug

Getting involvedBe the change you seek.

--Fifth Atlassian Value

Vital statistics

• The SDK is open source

• Apache License 2.0

• Frequent updates, new features and support for new product releases

• Outside committers contributing

Helping out

• Development IS at http://studio.atlassian.com/browse/AMPS

• Things YOU can help with right now:

• Documentation

• Testing on Windows

• Features YOU can help with:

• Per-plugin storage

Wrap-up

• SDK makes plugin and gadget creation easier

• Works in all products

• Faster code/test/debug cycle

• Tight integration with Atlassian

• Flexible enough to work in your system

Resources• Writing plugins: http://confluence.atlassian.com/x/

CgbvCw

• Marketplace: http://plugins.atlassian.com

• Hosting: http://studio.plugins.atlassian.com

• Forums: http://discuss.atlassian.com

• Contact Developer Relations:

• developer-relations@atlassian.com

• irc.freenode.net #atlassiandev

AtlasCamp 2010: The Atlassian Plugin SDK For Fun & Profit - Ben Speakmon

Technology

AtlasCamp 2010: Needs more jQuery - Using advanced Javascript in Atlassian Plugins - Zach Davis

Plugin Quality Check Penny Wyatt JIRA QA Team Lead Atlassian

Available Pages Space Details IDE Plugin ... - Atlassian€¦ · Overview of the IDE Plugin This page last changed on Jun 12, 2008 by smaddox. ... The 'Feature License' screen will

AtlasCamp 2013: Confluence Blueprints

AtlasCamp 2013: ADG / Lean UX

JIRA Mobile - Lightning Talk - AtlasCamp 2012

AtlasCamp 2015: Reverse engineering people

AtlasCamp 2010: Securing your Plugin - Penny Wyatt

AtlasCamp 2015: HipChat: Connecting to (allthethings)

AtlasCamp 2014: Connect Security

Presenting, a webinar and customer case review on… · 2015-05-29 · Atlassian"integra.on"Experts" ... Hub plugin. Enterprise Translations Hub plugin CONTINUOUS TRANSLATION PROCESS

Using the Atlassian Plugin Platform to Create Your Own SaaS Plugin Platform

AtlasCamp 2014: Know Your Funnel

AtlasCamp 2013: A Re-Intriduction to Atlassian Connect: Add-ons for OnDemand

AtlasCamp 2013: Keynote

AtlasCamp 2013: Confluence patterns

Plugin UI with AUI - Atlassian Summit 2012

AtlasCamp 2014: Preparing Your Plugin for JIRA Data Center

Enterprise Mail Handler - Atlassian Solutions & Services · Enterprise Mail Handler for JIRA (JEMH) ANDY BROOK • CTO • THE PLUGIN PEOPLE • ANDY@THEPLUGINPEOPLE 21.06.2017

AtlasCamp 2013: Modernizing your Plugin UI