Currents Documentation
Currents.devGitHubChangelog
  • Getting Started
    • What is Currents?
    • Playwright
      • Playwright: Quick Start
      • Troubleshooting Playwright
    • Cypress
      • Your First Cypress Run
      • Integrating with Cypress
        • Compatibility
        • Alternative Cypress Binaries
      • Troubleshooting Cypress
    • Jest
      • Your First Jest Run
      • Detox + Jest
      • Troubleshooting Jest
    • Others
    • CI Setup
      • GitHub Actions
        • Cypress - GitHub Actions
        • Playwright - GitHub Actions
        • Jest - GitHub Actions
        • Node.js - GitHub Actions
        • Commit data for GitHub Actions
        • Custom Docker runners
        • Named Runners
      • GitLab
        • Cypress - GitLab CI/CD
        • Playwright - GitLab CI/CD
        • Custom Docker runners
      • Jenkins
        • Cypress - Jenkins
        • Playwright - Jenkins
      • CircleCI
        • Cypress - CircleCI
        • Playwright - CircleCI
      • Bitbucket
        • Cypress - Bitbucket Pipelines
      • Azure DevOps
        • Cypress - Azure DevOps
        • Playwright - Azure DevOps
      • AWS Code Build
        • Cypress - AWS Code Build
        • Playwright - AWS Code Build
      • NX
        • Playwright - NX
        • Cypress - NX
  • Guides
    • Record Key
    • CI Build ID
    • Reporting
      • Reporting Strategy
      • Reporting in CI
      • Step-Level Reporting
    • CI Optimization
      • Playwright Parallelization
      • Orchestration Setup
      • Fully Parallel Mode
      • Re-run Only Failed Tests
      • Cloud Spot Instances
      • Failing Fast
      • Load Balancing
    • Code Coverage
      • Code Coverage for Playwright
      • Code Coverage for Cypress
    • Currents Actions
      • Setup Currents Actions
      • Using Currents Actions
      • Reference
        • Conditions
        • Actions
    • Playwright Component Testing
    • Playwright Visual Testing
    • Playwright Annotations
    • Playwright Tags
    • MCP Server
  • Dashboard
    • Projects
      • Projects Summary view
      • Project Settings
      • Archive and Unarchive Projects
    • Runs
      • Run Status
      • Run Details
      • Commit Information
      • Tags
      • Run Timeouts
      • Cancelling Runs
      • Deleting Runs
      • Run Progress
    • Tests
      • Spec File Status
      • Test Status
      • Flaky Tests
      • Test History
    • Test Suite Explorer
      • Test Explorer
        • Tests Performance
      • Spec Files Explorer
        • Spec Files Performance
      • Errors Explorer
  • Automated Reports
  • Insights and Analytics
  • Administration
    • Email Domain Based Access
    • SSO SAML2.0
      • SAML2.0 Configuration
      • SCIM User Provisioning
      • IdP-initiated Sessions
      • JumpCloud
        • JumpCloud User provisioning
      • Okta
        • Okta User provisioning
      • Troubleshooting SSO
    • Billing & Usage
  • Billing and Pricing
  • Resources
    • Reporters
      • cypress-cloud
        • Batched Orchestration
        • Migration to Cypress@13
      • @currents/cli
      • @currents/playwright
        • Configuration
        • pwc
        • pwc-p (orchestration)
        • Playwright Fixtures
      • @currents/jest
      • @currents/node-test-reporter
      • @currents/cmd
        • currents api
        • currents upload
        • currents cache
        • currents convert
      • Data Format Reference
    • Integrations
      • GitHub
        • GitHub App
        • GitHub OAuth
      • GitLab
      • Slack
      • Microsoft Teams
      • HTTP Webhooks
      • Bitbucket
    • API
      • Introduction
      • Authentication
      • API Keys
      • Errors
      • Pagination
      • API Resources
        • Instances
        • Runs
        • Projects
        • Spec Files
        • Test Signature
        • Test Results
    • Data Privacy
      • Access to Customer Data
      • Data Retention
      • Cloud Endpoints
    • Support
Powered by GitBook
On this page
  • Git Commands
  • GitHub Actions and Pull Requests
  • Overriding Commit Info
  • Troubleshooting Commit Info

Was this helpful?

  1. Dashboard
  2. Runs

Commit Information

Displaying Commit Information on Currents

PreviousRun DetailsNextTags

Last updated 3 months ago

Was this helpful?

Currents client SDKs use a set of git commands to obtain git commit information. This information is being used to display Run Details and enable certain platform features, for example

  • show analytics filtered by branch flakiness

  • searching items based on commit message

  • integration with SVC providers

If no commit information is available either from.git folder or from environment variables, no commit data will be shown in the dashboard.

Commit information must be available for Bitbucket, GitHub and GitLab integrations (PR comments, commit status updates).

Currents uses the following information:

Item
Source

Run Title

Commit message

Branch Link

Git origin + branch name

Commit Link

Git origin + commit SHA

Author

Commit author

Git Commands

Currents uses the following commands to get the commit data (see ):

  • git branch: git rev-parse --abbrev-ref HEAD

  • commit message: git show -s --pretty=%B

  • commit author email: git show -s --pretty=%ae

  • commit author name: git show -s --pretty=%an

  • commit SHA: git show -s --pretty=%H

  • git origin: git config --get remote.origin.url

GitHub Actions and Pull Requests

Item
Source

Run Title

Pull Request title

Commit Link

Pull Request discussion link

Commit SHA

Source branch latest commit SHA

You can change this behavior in Project Settings.

Overriding Commit Info

You can override the commit info by manually setting environment variables:

COMMIT_INFO_BRANCH: branch
COMMIT_INFO_MESSAGE: commit message
COMMIT_INFO_EMAIL: commit author email
COMMIT_INFO_AUTHOR: commit author name
COMMIT_INFO_SHA: commit info sha
COMMIT_INFO_TIMESTAMP: commit timestamp
COMMIT_INFO_REMOTE: remote origin

For example, if .git directory isn't available on the CI machine and the commands mentioned above return no value, you can set the environment variables explicitly. This method can be helpful for non-traditional setups, for example:

  • tests repo is different from application source code repo and you want to show the source code commit details in the dashboard

  • manual CI pipeline invocation

  • local testing

Troubleshooting Commit Info

If you're not seeing git information for your runs, most chances .git directory is not available in the CI environment and Currents can't detect the commit information automatically.

  • Run the Git Commands as part of your CI jobs manually and capture the output

  • Use the environment variables from Overriding Commit Info section

  • Contact our support channels for assistance

Currents automatically detects PR information, including PR title and the target branch when running in GitHub Actions as a result of GHA event. When a Pull Request is detected, Currents uses the following Pull Request data instead of the commit information.

Enable the corresponding client SDK debug mode ( or )

src/git-api.js
pull_request
Playwright
Cypress