Jira Tracking
Enrich your images with information from Jira
One of the major highlights of the Codefresh platform is the ability to automatically correlate software features with their deployment (where and when). While the software version of a component is easily identifiable, what is likely more interesting and important is to know which features are included in a release.
Codefresh has native integration for Atlassian Jira, allowing Codefresh to monitor a feature all the way from the ticket creation phase, up to when it is implemented and deployed to an environment.
Adding a Jira integration in Codefresh allows you to reference the integration in external CI tools such as GitHub Actions by the name of the integration account, instead of explicit credentials. See Image enrichment overview and GitHub Action integration.
Prerequisites
- Get your Jira instance credentials by following the Atlassian documentation.
- 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
Configure Jira integration in Codefresh
Once you have set up a Jira instance, configure the Jira integration settings in Codefresh.
- In the Codefresh UI, go to Integrations.
- Select Atlassian Jira, and then click Configure.
- Click Add on the top-right.
- Configure the Jira integration settings:
- Enter an Integration name. You can have multiple Jira instances connected.
- Use this integration for All runtimes, or specific Selected runtimes.
- 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.
- API Email: The email for the API token.
- To confirm, click Commit. It may take a few moments for the changes to be synced to the cluster before the integration account appears in the list.
Integration resource in shared configuration repo
The integration resource is created in the Git repository with the shared configuration, under 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/<runtime-name>/
Using Jira integration in 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.
Related articles
Shared configuration repo
Applications dashboard
Add Git sources to runtimes