Jira

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

Here are examples of the Images dashboard in Codefresh enriched with Jira information, and the Deployment tab in Jira with the reported information.

Images dashboard: Summary with enriched image information

Images dashboard: Summary with enriched image information

Deployment information reported in Jira

Deployment information reported in Jira

For general information on adding, editing, and deleting a Jira integration in Codefresh, see Issue-tracking integrations.

Prerequisites

Get your Jira instance credentials based on the type of integration selected:

  • Secret for deployment reporting
  • Auth Token for Jira enrichment

Secret (OAuth authentication) for deployment reporting

See Create OAuth credentials in Jira cloud.

  • In the Permissions list, make sure you select only Deployments.
  • After you click Create, note down the generated Client ID and Secret.

Set up OAuth credentials in Jira Cloud

Set up OAuth credentials in Jira Cloud

Auth Token (API token authentication) for Jira enrichment

See Manage API tokens for your Atlassian account.

Note down the following as you will need them to complete the integration with Codefresh:

  • Jira URL
  • Jira email
  • Jira token

Jira integration settings in Codefresh

The table describes the arguments required to integrate Jira in Codefresh, both for reporting deployment information back to Jira and for enriching images with Jira information.

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.
Report deployment information to Jira For deployment reporting only. When enabled, writes back to Jira when this integration is referenced in your CI pipeline.
Authentication
  • Secret for OAuth authentication, for reporting deployment information to Jira.
    • Jira Host: The URL of your Jira instance. For example, `https://.atlassian.net`
    • Client ID: The ID that was generated when you created OAuth credentials in Jira Cloud.
    • Secret: The secret that was generated when you created OAuth credentials in Jira Cloud.
  • Auth Token for API token authentication: Supported for enriching image with Jira information in Codefresh.
    • Jira Host: The URL of your Jira instance. For example, `https://.atlassian.net`
    • API TokenThe Jira API token for the Jira instance.
    • API Email: The email for the API token.
Test connection Click to verify that you can connect to the specified instance before you commit changes.

Integration settings for reporting deployment information to Jira

Integration settings for reporting deployment information to Jira

Integration settings for image enrichment with Jira information

Integration settings for image enrichment with Jira information

Using Jira integration in pipelines

In your CI pipeline, configure the Jira integration in Codefresh, and reference 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 repo
Image enrichment with integrations CI integrations
Container registry integrations