Sentry - BredaUniversityGames/JenkinsLib GitHub Wiki

sentry.upload()

Uploads debug symbols (PDB files) to Sentry for crash report symbolication.

Usage

stages {
    perforce.sync()
    ue5.build()
    sentry.upload()
    discord.alert()
}

Prerequisites

  • sentry-cli installed on the build agent
  • A Sentry organization and project configured
  • Sentry auth token stored as a Jenkins credential

Parameters

Parameter Default Description
SENTRY_CLI_PATH (empty) Path to sentry-cli.exe
SENTRY_AUTH_TOKEN_ID (empty) Jenkins credential ID for Sentry auth token
SENTRY_ORG (empty) Sentry organization slug
SENTRY_PROJECT (empty) Sentry project slug

Credential Setup

  1. Generate an auth token at Sentry Auth Tokens with project:releases and org:read scopes
  2. Navigate to your team's folder in Jenkins
  3. Credentials > Add Credentials
  4. Kind: Secret text
  5. Secret: paste your Sentry auth token
  6. ID: e.g., sentry-myproject

How It Works

  1. Runs sentry-cli upload-dif to scan the build output for debug information files
  2. Uploads PDB/DWARF files to Sentry
  3. Failures are non-fatal — if Sentry is offline, the build continues with a warning

Note: This stage gracefully handles Sentry being unavailable. A failed upload will log a warning but will not fail the build.

⚠️ **GitHub.com Fallback** ⚠️