TeamForge Webhooks-based Event Broker supports TeamForge—Jenkins integration. A new Jenkins integration plugin v2.0.6 is used to integrate TeamForge with Jenkins using TeamForge Webhooks-based Event Broker.
Before You Begin

It is assumed that you have installed the TeamForge Webhooks-based Event Broker on the TeamForge Application Server. For more information, see Install the TeamForge Webhooks-based Event Broker.

Configure Jenkins Integration Plugin to Notify the Webhooks-based Event Broker

The Jenkins integration plugin v2.0.6, which if configured, can notify the native TeamForge Webhooks-based Event Broker (WEBR) about the build data.

CollabNet Plugin Features

  • Notify TeamForge Webhooks-based Event Broker when builds complete.
  • Authenticate users from TeamForge. If set up as the “Build & Test” application, it can even use Single Sign-On.
  • Authorization from TeamForge, including the ability to set permissions in Jenkins based on roles in your TeamForge project.
  • Upload the build log or workspace artifacts to the TeamForge Documents.
  • Upload workspace artifacts to the TeamForge File Release System, as a post-build publishing task or as a build promotion task.
  • Open/update/close TeamForge Tracker artifacts based on the Jenkins build status.
  • Upload workspace artifacts to the Lab Management Project Build Library. (Requires CollabNet Lab Management).

    Click here to know more about the requirements for installing the latest CollabNet plugin.

EventQ has been deprecated in TeamForge 20.0 and later. Hence, you must configure Jenkins to notify the TeamForge Webhooks-based Event Broker (WEBR) for TeamForge-Jenkins integration.

Use the following instructions to have the Jenkins integration plugin notify the native Webhooks-based Event Broker.

  1. If you are integrating TeamForge and Jenkins for the first time:
    1. Log on to the Jenkins Server as a previliged Jenkins user, navigate to Manage Jenkins > Manage Plugins > Available.
    2. Select the latest CollabNet Plugin and install the plugin.
    3. Restart your Jenkins server.
    4. Go to step 4.
  2. Existing TeamForge-Jenkins integrations that use CollabNet Plugin v2.0.4 (or earlier):
    1. Log on to the Jenkins Server as a privileged Jenkins user, navigate to Manage Jenkins > Manage Plugins > Updates.
    2. Select the latest CollabNet Plugin and install the plugin.
  1. Configure an Individual Jenkins Job to notify the TeamForge Webhooks-based Event Broker.
  1. As a privileged Jenkins user, locate the job you wish to report build data to TeamForge Webhooks-based Event Broker and navigate to its configuration page.
  2. Add a post-build action to Notify TeamForge/EventQ when a build completes.
  3. Select the Notify TeamForge check box.
  4. Enter the TeamForge WebHook URL to which the build data will be sent, Username, and Password in the respective fields.

  5. By default, the Optional TeamForge Association View check box is selected. If required, you can override the global configuration by entering the TeamForge URL and user credentials.
  6. Save the job configuration.

  7. Run a build to test the new configuration and verify configuration. Information and errors will be reported to your Jenkins log and to the build console.

[]:

[]: