Improve this page on GitHub

Jira GitOps integration

Codefresh has native integration for Atlassian Jira to enrich images with information from Jira. Codefresh can monitor a feature all the way from the ticket creation phase, up to when it is implemented and deployed to an environment.

For information on adding a Jira GitOps integration in Codefresh, see Issue-tracking GitOps integrations.

Prerequisites

  1. Get your Jira instance credentials by following the Atlassian documentation.
  2. Note down the following as you will need them to complete the integration with Codefresh:
    • Jira URL
    • Jira username/email to be used for the integration
    • Jira password/token created for this user

Jira-GitOps integration settings in Codefresh

Setting Description
Integration name A friendly name for the integration. This is the name you will reference in the third-party CI platform/tool.
All Runtimes/Selected Runtimes The runtimes in the account with which to share the integration resource.
The integration resource is created in the Git repository with the shared configuration, within resources. The exact location depends on whether the integration is shared with all or specific runtimes:
  • All runtimes: Created in resources/all-runtimes-all-clusters/
  • Selected runtimes: Created in resources/runtimes//
You can reference the Docker Hub integration in the CI tool.
Jira Host The URL of your Jira instance. For example, https://<company>.atlassian.net
API Token The Jira password/token you noted down when you created the Jira instance.
To authenticate through a PAT (Personal Access Token) from your Git provider, see Using PAT instead of API token for Jira authentication.
API Email The email for the API token.

JIRA integration in Codefresh

JIRA integration in Codefresh

For information on adding a Jira integration in Codefresh, see Issue-tracking GitOps integrations.

Using PAT instead of API token for Jira authentication

In addition to API tokens, Codefresh supports using a PAT (Personal Access Token) from your Git provider for authentication to Jira servers. PAT-based authentication provides an alternative method to access Jira integrations for image enrichment with issue tracking information.

To authenticate through a PAT, you need to:

  • Explicitly configure the PAT through the CF_JIRA_SERVER_PAT argument.
  • Use CF_JIRA_HOST_URL with the URL of your Jira instance (instead of CF_ISSUE_TRACKING_INTEGRATION with the name of the Jira integration in Codefresh).

Here’s an example with the subset of JIRA-specific arguments you would use with PAT authentication:
CF_JIRA_HOST_URL: "https://codefresh-io.atlassian.net"
CF_JIRA_SERVER_PAT: "***"
CF_JIRA_MESSAGE: "wip CR-1"
CF_JIRA_PROJECT_PREFIX: "CR"

For detailed descriptions of arguments, see CI integrations argument reference.

Using GitHub Action with Jira in CI pipelines

For pipelines based on GitHub Actions, configure the Jira integration in Codefresh, and then connect your GitHub Action to Codefresh, referencing the Jira integration by name.
Codefresh uses the Secret Key stored in the runtime cluster to securely access Jira and retrieve the information.

Shared Configuration Repository
Image enrichment with GitOps integrations
CI integrations
Container registry integrations