Awesome

<img height="25" src="logos/test_visibility_logo.png" /> Datadog Test Optimization GitHub Action

GitHub Action that installs and configures Datadog Test Optimization. Supported languages are .NET, Java, Javascript, Python, and Ruby.

About Datadog Test Optimization

Test Optimization provides a test-first view into your CI health by displaying important metrics and results from your tests. It can help you investigate and mitigate performance problems and test failures that are most relevant to your work, focusing on the code you are responsible for, rather than the pipelines which run your tests.

Usage

1. Set Datadog API key inside Settings > Secrets as DD_API_KEY.

2. Add a step to your GitHub Actions workflow YAML that uses this action. Set the language and site parameters:

   steps:
     - name: Configure Datadog Test Optimization
       uses: datadog/test-visibility-github-action@v2
       with:
         languages: java
         api_key: ${{ secrets.DD_API_KEY }}
         site: datadoghq.com # Change if your site is not US1
     - name: Run unit tests
       run: |
         mvn clean test
   

[!IMPORTANT] It is best if the new step comes right before the step that runs your tests. Otherwise, installed tracing libraries might be removed by the steps that precede tests execution (for example, actions/checkout will wipe out whatever was installed in the action workspace).

Configuration

The action has the following parameters:

Additional configuration

Any additional configuration values can be added directly to the step that runs your tests:

- name: Run unit tests
  run: |
    mvn clean test
  env:
    DD_ENV: staging-tests
    DD_TAGS: layer:api,team:intake,key:value

Limitations

For security reasons Github does not allow actions to alter the NODE_OPTIONS environment variable, so you'll have to pass it manually.

Tracing JS tests (except vitest and cypress)

If you're running tests with vitest, go to Tracing vitest tests.

To work around the NODE_OPTIONS limitation, the action provides a separate DD_TRACE_PACKAGE variable that needs to be appended to NODE_OPTIONS manually:

- name: Run tests
  shell: bash
  run: npm run test-ci
  env:
    NODE_OPTIONS: -r ${{ env.DD_TRACE_PACKAGE }}

NOTE: To instrument your Cypress tests with Datadog Test Optimization, please follow the manual steps in the docs.

Tracing vitest tests

ℹ️ This section is only relevant if you're running tests with vitest.

To work around the NODE_OPTIONS limitation, the action provides a separate DD_TRACE_PACKAGE and DD_TRACE_ESM_IMPORT variables that need to be appended to NODE_OPTIONS manually:

- name: Run tests
  shell: bash
  run: npm run test:vitest
  env:
    NODE_OPTIONS: -r ${{ env.DD_TRACE_PACKAGE }} --import ${{ env.DD_TRACE_ESM_IMPORT }}

Important: vitest and dd-trace require Node.js>=18.19 or Node.js>=20.6 to work together.