When Trunk Flaky Tests detects a flaky test, you can create an automatically generated Jira ticket for your team to pick up and fix the test. Webhook payloads will also contain ticket information when a Jira ticket is created with the integration or when existing tickets are linked.Documentation Index
Fetch the complete documentation index at: https://trunk-4cab4936-mintlify-migrate-trunk-docs-1778256504.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Connecting to Jira
To connect a Jira Cloud project, navigate to Settings -> Repositories -> Ticketing Integration and select Jira as your Ticketing System. Then complete the form and click Connect to Jira Cloud with the following information.| Field Name | Description | Examples |
|---|---|---|
| Jira URL | The URL to your Jira Cloud project. | https://trunk-io.atlassian.net |
| Project Key | The project key for your Jira project. | KAN |
| The email associated with your Jira API token. | johndoe@example.com | |
| Jira API token | Create your Jira API token here. | ATATT*****19FNY5Q |
| Default label(s) for new tickets | Labels applied to new Jira tickets created through Trunk Flaky Tests | flaky-test, debt |
API Token permissions
Your Jira user account must have the following project permissions to create a Jira API token that allows Trunk to read, create, and assign tickets automatically:- Create issues
- Assign issues OR Browse users and groups (global permission)
- Browse projects
- If issue-level security is configured, issue-level security permissions must be granted to read issues.
- Required scopes (classic)
read:jira-workwrite:jira-workread:jira-user
- Required scopes (granular):
read:issue:jiraread:issue-meta:jiraread:issue-security-level:jiraread:issue.vote:jiraread:issue.changelog:jiraread:avatar:jiraread:status:jiraread:user:jiraread:field-configuration:jiraread:application-role:jiraread:group:jiraread:issue-type:jiraread:project:jiraread:project.property:jiraread:issue-type-hierarchy:jiraread:project-category:jiraread:project-version:jiraread:project.component:jiraread:permission:jirawrite:issue:jirawrite:comment:jirawrite:comment.property:jirawrite:attachment:jira
Jira tokens cannot last longer than 365 days. Once the token expires, you will need to generate a new API token.
Create a new ticket
You can create a new ticket for any test listed in Trunk Flaky Tests. There are 2 ways to create a new ticket in the Flaky Test dashboard:- Click on the options menu for any test case on the repo overview dashboard
- Use the Create ticket button in the top left corner of the test case details page.
Create with Jira
If you are connected to Jira, you can click the Create Jira Ticket button at the end of the modal, which will automatically create a ticket with the configured labels and assignees.Link existing tickets to tests
If you already have a ticket in Jira that you want to link to a test in the dashboard, you can use the Link Ticket to Test Case API.Required Custom Fields
Some Jira projects require additional fields beyond the standard fields (like summary, description, and issue type) to be specified when creating tickets. Common required custom fields include:- Components - Categories or modules within your project
- Affects Version - Which version of your product is impacted
- Fix Version - Target version for the fix
- Epic Link - Parent epic for the ticket
- Sprint - Sprint assignment
- Story Points - Estimation field
- Custom fields specific to your organization
Enterprise Feature
If your Jira project requires custom fields that aren’t supported in the standard Trunk Flaky Tests integration, you’ll see an error message when attempting to create a ticket:Alternative: Remove Field Requirements
If you don’t need Enterprise features, you can modify your Jira project settings to make custom fields optional instead of required. This allows Trunk Flaky Tests to create tickets without needing to specify those fields. To make a field optional in Jira:- Navigate to Project Settings in your Jira project
- Select Issue Types from the sidebar
- Choose the issue type you’re using for flaky test tickets (e.g., Task, Bug)
- Click Fields to see all fields for that issue type
- Locate the required custom field (e.g., “Components”)
- Click the field to open its configuration
- Uncheck Required or change the field requirement setting
- Save your changes
Note: You may need Jira Administrator permissions to modify project settings. If you don’t have access, contact your Jira administrator to make these changes.