Improve this page on GitHub

GitOps issue tracking integrations

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.

Adding an issue-tracking integration in Codefresh allows you to reference the integration in third-party CI platforms/tools such as GitHub Actions and Codefresh pipelines by the name of the integration, instead of explicit credentials. See Image enrichment with GitOps integrations and CI integrations for GitOps.

You add an issue-tracking integration in Codefresh by:

  • Defining the integration name
  • Selecting the runtime or runtimes it is shared with
  • Defining the arguments
  • Committing the changes

Once added, Codefresh displays the list of existing integrations with their sync status. You can edit or delete any integration.

Configure issue tracking integrations for GitOps in Codefresh

Configure the settings for an issue tracking integration for GitOps in Codefresh.

  1. In the Codefresh UI, on the toolbar, click the Settings icon, and then from the sidebar, select GitOps Integrations.
  2. Filter by Issue Tracking, select the issue tracking tool to integrate, and click Configure.
  3. Jira integrations only: For a new Jira integration, from the Add Integration dropdown, select the type of integration, as either Deployment reporting or Image enrichment.
  4. If you already have integrations, click Add.
  5. Define the arguments for the issue tracking tool:
    Jira
  6. To confirm, click Commit. It may take a few moments for the new integration to be synced to the cluster before it appears in the list.

Integration resource in shared configuration repo

The resource for the issue-tracking integration 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/<runtime-name>/

View issue-tracking integrations for GitOps

Selecting an issue tracking tool displays the existing integrations in Codefresh.

Every issue tracking integration displays the following information:

  • Name of the integration
  • Runtime or runtimes it is shared with
  • Sync status

Edit/delete issue-tracking integrations for GitOps in Codefresh

If you have existing integrations, you can change the credentials, or delete an integration.

IMPORTANT
Deleting an integration deletes the integration resource from the Shared Configuration Repository, its secrets, and the CI workflows that use it.

  1. In the Codefresh UI, on the toolbar, click the Settings icon, and then from the sidebar, select GitOps Integrations.
  2. Filter by Issue Tracking, and select the specific integration.
  3. In the row with the integration to edit or delete, click the three dots and select Edit or Delete.
  4. To edit, update the Username and Password fields, and click Test Connection to verify the account credentials.
  5. To delete, type DELETE in the text box as instructed.

Delete issue-tracking integration

Delete issue-tracking integration

Shared Configuration Repository
CI GitOps integrations
Container registry GitOps integrations