Skip to main content

Jira Plugin

To use the Jira plugin, Venue.sh requires an API token to communicate with Jira APIs. This document outlines the process of creating and setting up the API token.

Generating an API Token​

  1. Navigate to the user profile settings page for your Jira account: Jira API Tokens.

    tip

    We suggest creating a dedicated automation/bot account for API usage.

  2. Click Create Classic API Token.

  3. In the Create an API Token modal, name the token "Venue.sh" to easily identify it later.

  4. Click Create.

    The new API token appears on the screen.

  5. Copy and save the token in a secure location.

    tip

    Atlassian displays the API token only once, so make sure you save it in a secure place. You won't be able to see it again!

Configuring the Jira Plugin in Venue.sh​

To configure the Jira plugin in Venue.sh, follow these steps.

  1. In the Venue.sh app, click Plugins in the left-side navigation.

  2. Find Jira, then click Enable Plugin.

  3. On the configuration modal, enter the values for the following three fields:

    • Target: Your Jira Cloud domain (e.g. https://venuesh.atlassian.net)

    • Authorization: Your Base64-encoded string for your email/Jira token.

      1. First, format your email address and Jira token as follows:

        <account-email>:<jira-token>

        email@example.com:9bljDpJKRev44C3z

      2. Next, convert your email:Jira token to Base64.

        tip

        Here's a shortcut to CyberChef, a tool that helps you quickly encode text to Base64.

      3. Add "Basic" to the front of your new Base64 string, which will look similar to this:

        Example: Basic Y29vbHBwbFJraW5kQG1haWwuY29tOmpkYWg4a2RqdzlhMjJzcw==

      4. Add this Base64 string to the Authorization field.

    • User-Agent: Enter "Mozilla/5.0"

Component setup​

Within your component catalog-info.yaml file, add the following annotations to connect your Jira project:

metadata:
  annotations:
    jira/project-key: [YOUR_PROJECT_KEY]
    jira/component: [YOUR_COMPONENT]
tip

You can skip the jira/component line to fetch data for all components across multiple Jira projects.

References​

Looking for more information? Check out the following resource: