The Adaptavist Group LogoDocumentation

Jenkins Plugin

The Jenkins plugin allows users to associate an entity with one or more Jenkins jobs. Users can easily view the status of current builds linked or related to the entity. The plugin also provides direct access to Jenkins, allowing users to open and run specific jobs from there directly.

Configuring the Jenkins Plugin in Venue.sh

  1. In the Venue.sh app, click Plugins in the left-side navigation.
  2. Find Jenkins, then click Enable Plugin.
  3. Enter the Base URL value for the Jenkins instance.
  4. Enter the Username value, which is the username used to log into Jenkins.
  5. Enter the API Key value.
    Tip:
    To generate an API key in Jenkins:

    1. Log in to Jenkins as an administrator.

    2. Navigate to Manage Jenkins → Manage Users.

    3. Select a user to generate an API key for.

    4. On the configuration page, click Add new token.

    5. Copy the new API token.

    6. Click Save.

  6. Click Validate & Enable.

Using Jenkins in the Venue.sh Catalog

Once the Jenkins plugin is configured and enabled in Venue.sh, follow these steps to edit an existing catalog entry to enable Jenkins jobs:

  1. Navigate to the Catalog, and select a component to edit.
  2. In the component About section, click Edit.
  3. In the Optional metadata section, click Toggle optional fields, then select Jenkins.
    The Jenkins Job Full Name text bar appears on the screen.
  4. Add a valid Jenkins job in the text box.
    Tip:

    You can add multiple Jenkins jobs if separated by a comma.

  5. Click Save changes.
    Once the changes save to the database, a new Jenkins tab appears on the component page, from which you can view build details.

Search documentation

Start typing to search the docs.