trunk-io/analytics-uploader action. Version 3 of the action installs the trunk CLI and runs trunk flakytests for you.
Before you start these steps, see the Test Frameworks docs for instructions on producing Trunk-compatible reports for your test framework.
Setup steps
Work through the steps below in order. Once you’ve finished the last one, you’re set up — navigate to app.trunk.io to see your results.Trunk Organization Slug and API Key
Before setting up uploads to Trunk, you must sign in to app.trunk.io and obtain your Trunk organization slug, an API key, and the ID of the test collection to upload to.Trunk Slug
You can find your organization slug under Settings → Organization → General. You’ll save this as a variable in CI in a later step.Trunk API Key
Create an API key under Settings → Developer → API Keys with the Create Key button, and select the Upload test results permission. The key starts withtrunk_v2_ and is shown only once. See Create an API key.
Test Collection ID
Create a test collection under Flaky Tests → Collections, or open an existing one, and copy its ID from the collection’s page header. It is not a secret, so you can include it directly in your upload command.Add Your API Key as a Secret
Store the API key from the previous step in your repo as a GitHub secret namedTRUNK_API_KEY. The organization slug isn’t a secret, so you can write it in the workflow or store it as a variable.
Upload to Trunk
Add anUpload Test Results step after running tests in each of your CI jobs that run tests. This should minimally include all jobs that run on pull requests, as well as jobs that run on your main or stable branches, for example, main, master, or develop.
Example GitHub Actions Workflow
The following is an example of a GitHub Actions workflow step to upload test results after your tests using Trunk’s Analytics Uploader Action. The action runs on Linux and macOS runners (macOS 14 or later). Windows runners are experimental. To find out how to produce the report files the uploader needs, see the instructions for your test framework in the Test Frameworks docs.Upgrading from v2
Version 3 of the action runs the Trunk Analytics CLI 1.x through thetrunk CLI. To move a workflow from @v2 to @v3:
- Replace the
tokenvalue with an API key that has the Upload test results permission. The Trunk Analytics CLI 1.x refuses the legacy organization token. To keep using that token for now, stay on@v2, which runs a 0.x release of the Trunk Analytics CLI. - Set
test-collection-idon every step. It’s required. - Remove the
hide-bannerandpublic-repo-idinputs. Version 3 doesn’t have them. For uploads from fork pull requests, useallow-forked-pr-uploads.
quarantine: false still turns off quarantining for the step.
Enable quarantining
You can quarantine flaky tests by wrapping the test command or as a follow-up step.- GitHub Actions Workflow
- Using the trunk CLI
Using the Trunk Analytics Uploader Action in your GitHub Actions Workflow files, may need modifications to your workflow files to support quarantining.If you upload your test results as a second step after you run your tests, you need to add
continue-on-error: true on your test step so your CI job will continue even on failures.run: <COMMAND TO RUN TESTS> parameter.This will override the response code of the test command. Make sure to set continue-on-error: false so un-quarantined tests are blocking.Stale files
Ensure you report every test run in CI and clean up stale files produced by your test framework. If you’re reusing test runners and using a glob like**/junit.xml to upload tests, stale files not cleaned up will be included in the current test run, throwing off detection of flakiness. You should clean up all your results files after every upload step.
Validate Your Uploads
Once your workflow has run on a stable branch, navigate to app.trunk.io and confirm Trunk received your results.- The Uploads tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on).
- The Tests tab shows individual test cases once an upload has been processed.
TRUNK_API_KEY secret is set on the repo running the workflow, the key has the Upload test results permission, and the collection ID is correct.
Getting Direct Links to Job Logs
Direct Links to Job Logs is an optional configuration, and relies on a third-party actions dependency.
JOB_URL environment variable using a third-party action to extract the job ID.
Setup
- Add the job ID extraction step to your workflow using a community action:
- Pass the job URL when uploading test results:
Complete Example
Here’s a full workflow example with direct job linking:How It Works
- The
ayachensiyuan/get-action-job-idaction extracts the GitHub Actions job ID - We construct the full job URL using:
https://github.com/{repo}/actions/runs/{run_id}/job/{job_id} - This URL is passed to Trunk via the
JOB_URLenvironment variable - When you click “Logs” on a test failure in Trunk, you’ll go directly to that job’s logs instead of the workflow overview
Notes
- The
job-nameparameter must exactly match your job’snamefield - The
GITHUB_TOKENmust have appropriate permissions to read workflow job information - If the job ID extraction fails, Trunk will fall back to linking to the workflow run