Skip to main content
Ask AI

GitHub Actions Integration

The GitHub Actions integration connects your CI pipeline to the TestRelic session workspace, enabling build timeline visualization, workflow triggering, and bidirectional deep linking between test sessions and CI runs.

What this integration enables​

  • CI build timeline — A visual timeline of your GitHub Actions workflow steps, displayed in the session workspace alongside test results.
  • Build links — Each test run card in the dashboard shows a direct link to the GitHub Actions run that triggered it.
  • Workflow trigger — Trigger a GitHub Actions workflow directly from the TestRelic platform (useful for re-running a failed CI check without leaving the platform).
  • Run metadata — Branch, commit SHA, workflow name, and run number are surfaced in the run list and session detail.

Connecting GitHub Actions​

  1. Navigate to Settings → Integrations.
  2. Click Connect on the GitHub Actions card.
  3. In the connection dialog, provide:
    • Your GitHub organization or username.
    • A GitHub Personal Access Token (PAT) with repo and actions scopes (or a GitHub App installation token).
    • The repository name to connect.
  4. Click Save to verify and store the connection.
Token scopes required

The PAT must have at minimum:

  • repo — to read repository and workflow data
  • actions:read — to list workflow runs
  • actions:write — to trigger workflow dispatches (required for workflow trigger feature)

CI build timeline​

When the integration is connected, the GitHub Actions tab in the Test Case Detail view and Session Workspace renders a step-by-step CI build timeline:

  • Each workflow job is displayed as a timeline segment.
  • Step names, durations, and statuses are shown.
  • A link to the full GitHub Actions run opens in a new tab.

Triggering workflows​

From within the session workspace or the run detail page, use the Trigger Build button to dispatch a workflow run on GitHub Actions. This uses the workflow dispatch event.

Actions write permission required

Workflow triggering requires the actions:write scope on your GitHub token. If the token does not have this scope, the trigger button is disabled.

Auto-detected CI metadata​

Even without the integration connected, TestRelic auto-detects GitHub Actions metadata from the reporter:

  • Workflow name and run number (from GITHUB_WORKFLOW and GITHUB_RUN_NUMBER environment variables)
  • Commit SHA (GITHUB_SHA)
  • Branch (GITHUB_REF_NAME)

This metadata is displayed in the run list and session detail automatically. The integration adds the build timeline and workflow trigger capabilities on top.