Build Notifications Plug-in

Added by Gunnar Wagenknecht, last edited by Gunnar Wagenknecht on Nov 22, 2007  (view change) show comment
Name Build Notifications Plug-In
Version 1.0
Author(s) Gunnar Wagenknecht
Homepage Build Notifications Plug-in
Issue Tracking JIRA
Availability JIRA 3.11+
Price free!
License BSD
Download JAR  
Download Source Subversion
Browse Source Fisheye

Description/Features


This plug-in lets you publish build information from any build system to JIRA. A client runs as part of the build process and submits the build log together with a build id to JIRA. The server side of this plug-in analyzes the log and attaches the build id to all found issues into a related builds custom field. If configured it also updates the fixed versions for an issue.

Installation

The installation is straight forward. Currently, you need to build the JAR file manually. In the future, we'll provide a ready to deploy JAR file.

  1. Checkout plug-in source code
  2. Build the plug-in
  3. Deploy the JAR file to <jira>/WEB-INF/lib
  4. Integrate the client script with your build system

Integration

CruiseControl

There is an example publisher for CruiseControl in the repository.

You register it in your CruiseControl configuration like this:

<plugin
    name="jirabuildnotifications"
    classname="org.eclipseguru.jira.buildnotifications.client.cruisecontrol.JIRABuildNotificationsPublisher"
    url="https://my.jiraserver.com/jira"
    username="theusername"
    password="thepassword" />

And the use it like this:

<publishers>
    <onsuccess>
        <jirabuildnotifications />
    </onsuccess>
</publishers>

Labels

build_integration build_integration Delete
plugin plugin Delete
jira jira Delete
cruisecontrol cruisecontrol Delete
builds builds Delete
continuous_integration continuous_integration Delete
ccnet ccnet Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (12)

 

  1. Nov 22, 2007

    Sam M says:

    Hi,\\ This plugin sounds interesting. Could you please provide more information ...

    Hi,

    This plugin sounds interesting.

    Could you please provide more information about this plugin and an example how to use it. For example, if Cruise Control is used for continuous build and the build information (build id + version) needs to be integrated Jira. How to do that with this plugin? How the build log is submitted to the Jira server instance?

    Br,

    Sam 

    1. Nov 22, 2007

      Gunnar Wagenknecht says:

      You need to setup a "publisher" in your CruiseControl configuration. The publish...

      You need to setup a "publisher" in your CruiseControl configuration. The publisher would take the modifications log and push it to the JIRA server via XMLRPC. I've committed an example publisher to the repository.

      You register it in your CC configuration like this:

      <plugin
    name="jirabuildnotifications"
    classname="org.eclipseguru.jira.buildnotifications.client.cruisecontrol.JIRABuildNotificationsPublisher"
    url="https://my.jiraserver.com/jira"
    username="theusername"
    password="thepassword" />

      And the use it like this:

      <publishers>
    <onsuccess>
        <jirabuildnotifications />
    </onsuccess>
</publishers>

      1. Dec 05, 2007

        Nathan L. Walls says:

        Ok, I have the plugin and publisher in place on Cruise Control. But where would ...

        Ok, I have the plugin and publisher in place on Cruise Control. But where would that build be reflected in JIRA? I know there's supposed to be a custom field the build information shows up in, but how does the build identify with that particular issue/project?

        Thanks!

        1. Dec 05, 2007

          Gunnar Wagenknecht says:

          The custom field is created automatically once you submit the first changelog. T...

          The custom field is created automatically once you submit the first changelog. The project information is actually contained in the issue key. Have a look at the jira-buildnotifications-plugin.properties to get an idea of what else is possible.

  2. Dec 11, 2007

    jens says:

    Hi, i have made a port of your cruisecontrol client to the cruisecontrol.net equ...

    Hi,

    i have made a port of your cruisecontrol client to the cruisecontrol.net equivalent. Give me a note if you are interested to add it to the repository.

    1. Dec 11, 2007

      Gunnar Wagenknecht says:

      Great. :) Can you open a JIRA issue and attach it as a ZIP (or patch)?

      Great. Can you open a JIRA issue and attach it as a ZIP (or patch)?

      1. Dec 11, 2007

        jens says:

        I have added it as attachment. :) Does the jira plugin add a version although th...

        I have added it as attachment.

        Does the jira plugin add a version although there are no issue keys in the changelog message? would be nice if cc automatically would add versions according to build labels even if there are no issues

  3. Dec 18, 2007

    Alexey Bodrov says:

    Hi\! I'm so sorry, but I don't understand, where and how i download this \.jar f...

    Hi!

    I'm so sorry, but I don't understand, where and how i download this *.jar file.

    I can't checkout ./trunk/... to the my working copy. Please, tell me how can I chekout this project and how can I build this file.

    And if who has this file, please, send me via e-mail:
    alexey.bodrov@itv.ru

    Thx a lot! 

  4. Jan 17, 2008

    Ajay Gupta says:

    Hello, &nbsp;I was able to get the plugin to work.&nbsp; There are some tricks t...

    Hello,

     I was able to get the plugin to work.  There are some tricks to get it to build etc.  We are using the plugin with Cruise Control and JIRA 3.12.  The best strategy is to:

     1. When downloading the source code, use Tortoise SVN to fetch the plugin code from the Internet since I could not get it straight into Eclipse through our firewall.

     2. Import the Tortoise SVN import into Eclipse using File | Import | Existing Projects into Workspace option.

     3. Set the source folder to src in Eclipse for the server project so that the folders will show up correctly under Package Explorer in Java perspective.

     4. Add the files required in CLASSPATH of the server project from the JIRA you are using.  You can get the list of dependencies from .classpath file that comes with the plugin code and then, go and get the version of those files from your JIRA installation.

    5.  Ensure that you include WEB-INF/classes in the CLASSPATH.

    6.  Put the client in a separate project and copy it to Cruise Control.

    7.  Restart CC and it works.

    I would like if the plugin will only create entries in JIRA ticket only for builds that have a specific label.  I should be able to tell the plugin to only add entries if the label is of the format: prod_xxxx... since I may not want to include the daily builds that may occur in my repository through Cruise Control etc.  Right now, the plugin is adding an entry under Versions tab every time we do a CC build.

     Is it also possible for the tool to instead put the info by creating a tab called "Build Tool" and put the info there. That is where other tools like Fisheye, Crucible plugins for JIRA put their info in JIRA.

    Can we customize the build tool URL that this plugin provides? Right now, it is only including the buildId in the client.  What if I wanted to provide a URL like: http://<cruise control base URL/<project-name>?log=<log-file-name>&buildId=<build-id>.

    I will be happy to share details of the installation with anyone who is interested.

    1. Jan 18, 2008

      Gunnar Wagenknecht says:

      Thanks for this great feedback\! As you recognized, the project setup is not fin...

      Thanks for this great feedback!

      As you recognized, the project setup is not finished yet. The way I have it it my workspace (and the way it's configured in the .classpath and .project files committed to SVN) is that I have the JIRA source zip unexploded into an Eclipse project called "jira". If you don't have the source you need a different setup.

      As for the other requests I'm pretty sure that's possible. I created the plug-in because we needed it and I wanted it to be generic enough to work with different build systems. It's a first attempt and it would be cool if we could extend it to be a great plug-in. It would be awesome if you could submit your requests as JIRA issues. Feel free to attach a patch if you like.

      Regarding the daily builds issue, we have different CruiseControl projects for nightly builds and integration builds and only added the publisher to our integration builds. 

  5. Jan 29, 2008

    ria ninan says:

    Hi, I have a requirement where I need to display a cruise control server data in...

    Hi,
    I have a requirement where I need to display a cruise control server data in chart format in the JIRA website...But I donot know much about this as I am quite new to this...Can you please suggest me some way to meet my requirement like What excatly I must do???

  6. Jul 10

    Didier Levesque says:

    I'm not a J2ee developer , but I would like to install this plugins. I'm able to...

    I'm not a J2ee developer , but I would like to install this plugins. I'm able to compile the code and produce the jar file , but I don't know what to include in this jar file. Could someone help me with this one?

     Thanks .

    Didier