Linear Integration
Learn how to automatically create Linear issues with Flaky Test webhooks
Last updated
Learn how to automatically create Linear issues with Flaky Test webhooks
Last updated
Trunk allows you to automate Linear Issue creation through webhooks. This will allow you to create Linear issues and auto-assign according to CODEOWNERS.
This guide will walk you through integrating Trunk Flaky Tests with Linear Issues through webhooks. You will be able to automatically generate Linear issues for new flaky tests found in your repo that impact more than 2 PRs. This guide should take 15 minutes to complete.
Before you can create a webhook to automate GitHub Issue creation, you need to create an API token to authorize your requests.
In the Linear app, navigate to settings by holding G
and pressing S
, or by clicking on your profile on the top left and clicking Settings.
Under Account > Security & Access > Personal API Keys, Click New API Key to create a new access token.
Copy the new API key and save it in a secure location. You'll need to use this later.
Trunk uses Svix to integrate with other services, such as creating Linear Issues through webhooks.
You can create a new endpoint by:
Login to Trunk Flaky Tests
From your profile on the top right, navigate to Settings
Under Organization > Webhooks, click Automate Linear Issues Creation.
Paste the Linear GraphQL API endpoint into Endpoint URL, which is: https://api.linear.app/graphql
.
Review the transformation code automatically generated for Linear issues, you can customize this transformation at any time. Learn more about customizing transformations.
Create the new endpoint. You will be redirected to the endpoint configuration view.
If you're having trouble adding a new webhook endpoint with Svix, please see the Adding Endpoint docs from Svix.
The Linear GraphQL API requires some custom headers. You can configure custom headers in the endpoint configuration:
You can add custom headers under Webhooks > Advanced > Custom Headers.
Fill in the Key and Value referencing the table below, and click the + button to add each header.
You'll need to configure the following headers.
Authorization
<YOUR_API_TOKEN>
You need to find your Linear team, project, and label IDs to create issues with the appropriate labeling. You can do this by querying your Linear project using cURL.
First, you'll need to find your team ID so you can create Linear issues under the correct team. You can make a request in your terminal using cURL, or a similar tool.
You'll need your Linear API key from step 1.
You will receive a response that contains your team UID, for example:
If you want to create issues under a specific project, you'll need to find its project ID. You can use a query like this:
You'll receive a response that contains your projects and their IDs, for example:
If you want to create issues with a specific label, you'll need to find its label ID. You can use a query like this:
You'll receive a response that contains your labels and their IDs, for example:
Transformations are custom code snippets you can write to customize the Linear issues created by the webhook. A working template transformation will be added automatically for your webhook, but you can further customize the behavior of this webhook.
In the endpoint configuration view, navigate to the Advanced tab. Under Transformation, toggle the Enabled switch.
Click Edit transformation to update your transformation code, and click Save to update the transformation.
You can test the transformation by selecting the test_case.status_changed
payload and clicking Run Test. This will test the transformation but not send a message. You will learn to send a test message in step 6.
The generated webhook template contains several configurable constants out of the box:
LINEAR_TEAM_ID
LINEAR_PROJECT_ID
LINEAR_LABEL_IDS
PRS_IMPACTED_THRESHOLD
Issues will be created only for flaky tests that have impacted more PRs than the PRS_IMPACTED_THRESHOLD
.
You can adjust this value if you see many issues about low-impact flaky tests.
Here is the provided transformation for context. You can customize your Linear Issues integration by following the Linear API and Svix transformations documentation.
If you have CODEOWNERS configured in your repo, it will be reported by Trunk in the webhook payload. You can use this to map different CODEOWNERS to Linear assignees. You can access CODEOWNERS in the payload like this: webhook.payload.test_case.codeowners
.
Since the way your owners map to your Linear user is unique to your team, you'll need to provide your own mapping to convert code owners to their Linear ID.
You can modify your issue create payload like this to include an assignee:
You can create test issues by delivering a mock webhook. You can do this by:
In the endpoint configuration view, navigate to the Testing tab and select a Send event
Under Subscribed events, select test_case.status_changed
as the event type to send
Click Send Example to test your webhook
A Linear Issue will now be created when a test's health status changes to flaky and impacts more than 2 PRs. You can further modify your transformation script to customize your issues.
See the Trunk webhook event catalog
(Required) Your Linear team ID. .
(Optional) The Linear project ID assigned to new issues. .
(Optional) Array of label IDs assigned to new issues. .
You can monitor the events and the webhook's delivery logs in the Overview tab of an endpoint configuration view.
You can see an overview of how many webhook deliveries have been attempted, how many are successful, how many are in flight, and how many fail in the Attempt Delivery Status modal.
You can see a list of past delivery attempts in the Message Attempts modal. You can filter this list by Succeeded and Failed status, and you can click on each message to see the Message content, response code, and error message of each attempt. You can learn more about replaying messages and filtering logs in the Svix docs.