O'Reilly logo

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Practical JIRA Plugins

Book Description

One advantage of using JIRA for issue tracking, bug tracking, or project management is the ability to extend this tool with hundreds of plugins from the JIRA community. In this concise book, software toolsmith Matt Doar—the author of Practical JIRA Administration—shows you how to create and maintain your own JIRA plugins to meet the specific needs of a project.

This book uses detailed examples to clarify some of the more confusing aspects of JIRA plugins, and serves as an ideal supplement to the extensive documentation already available.

  • Use JIRA’s Plugin SDK, and learn several aspects common to all plugins
  • Create your own custom field type, using a JIRA plugin
  • Delve into advanced aspects of custom field plugins, and discover how searching for values in custom fields works
  • Create JIRA plugins to use with workflows, and learn about conditions, validators, and post-functions
  • Store data using the PropertySet interface and the Active Objects plugin
  • Upgrade a plugin and upload it to Atlassian Plugin Exchange (PAC)

Table of Contents

  1. Preface
    1. What This Book Is About
      1. JIRA Versions and System Details
      2. Development Environment
      3. Technical Reviewers
    2. Conventions Used in This Book
    3. Using Code Examples
    4. Safari® Books Online
    5. How to Contact Us
    6. Content Updates
      1. September 2012
    7. Acknowledgments
  2. 1. Plugin Basics
    1. Overview
    2. Creating a JIRA Plugin
      1. Important Plugin Files
    3. Reading a Plugin
    4. Building and Deploying a Plugin
      1. Using atlas-run and atlas-cli
    5. What Can JIRA Plugins Do?
      1. Custom Fields
      2. Workflow
      3. User Interface
      4. Reporting
      5. Remote Access
      6. Other Plugin Module Types
    6. Which Methods Should My Plugin Use?
    7. Troubleshooting a Build
    8. Logging
    9. Apache Velocity
    10. Maven
    11. Further Reading
  3. 2. Custom Field Types
    1. Overview
    2. A New Custom Field Type
    3. Generating an Empty Plugin
    4. Adding a customfield-type to atlassian-plugin.xml
    5. Creating the CustomFieldType Class
    6. Adding Velocity Template Files
    7. Troubleshooting the Plugin
    8. Extending the Plugin
    9. Summary
    10. Further Reading
  4. 3. Advanced Custom Field Types
    1. Overview
    2. Adding Configuration to a Custom Field
      1. A New FieldConfigItemType
      2. Velocity Templates and a WebWork Action
      3. Configuration Storage
      4. Configuration Summary
    3. Fields with Multiple Values
      1. CustomFieldType Methods
      2. Other Interfaces
      3. Velocity Templates for Multiple Values
      4. Multiple Values Summary
    4. Read-only and Calculated Fields
    5. WebWork
    6. Other Examples of Custom Field Types
  5. 4. Custom Field Searchers
    1. Overview
    2. How Searchers Work
      1. Methods for a Custom Field Searcher
      2. Adding Data to the Lucene Index
      3. Executing a Search
    3. Searchers and atlassian-plugin.xml
    4. A Simple Searcher
    5. Troubleshooting Searchers
    6. More Complex Searchers
    7. Statistical Searchers
    8. Further Reading
  6. 5. Workflow Customizations
    1. Overview
    2. Conditions
    3. Configurable Conditions
    4. Validators
    5. Configurable Validators
    6. Post-Functions
    7. Configurable Post-Functions
    8. Further Reading
  7. 6. Storing Data with Your Plugin
    1. Overview
    2. Storing Data with PropertySet
      1. An Example of Storing Data
      2. Accessing the Data
      3. Further Examples and Resources
    3. Storing Data with Active Objects
      1. Accessing the Data
    4. Further Reading
  8. 7. Publishing Your Plugin
    1. Overview
    2. Atlassian Marketplace
    3. SPAC (studio.plugins.atlassian.com)
    4. bitbucket
    5. Upgrading a Plugin to a New Version of JIRA
    6. Updating a Plugin Version at the Marketplace
    7. Further Reading
  9. 8. Further Plugin Information
    1. Overview
    2. JIRA Plugins—Beyond the .jar file
    3. Internationalization
    4. Plugin Security
    5. Version One, Version Two and Version Three Plugins
    6. JIRA Development Mode
    7. Using a Debugger with JIRA
    8. Further Reading
  10. About the Author
  11. Colophon
  12. Copyright