Continuous Testing and CI GitHub Actions

Overview

Trigger Synthetic tests from your GitHub workflows with the Datadog CI Synthetics command.

Setup

To get started:

1. Add your Datadog API and Application Keys as secrets to your GitHub repository. For more information, see API and Application Keys.
2. In your GitHub workflow, use DataDog/synthetics-ci-github-action.

Your workflow can be simple or complex.

Simple workflows

Example workflow using public IDs

name: Run Synthetic tests using the test public IDs
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.12.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}
          public_ids: 'abc-d3f-ghi, jkl-mn0-pqr'

Example workflow using an existing synthetics.json file

name: Run Synthetic tests using an existing synthetics.json file
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.12.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}

For an example test file, see this test.synthetics.json file.

Note: By default, this workflow runs all the tests listed in {,!(node_modules)/**/}*.synthetics.json files (every file ending with .synthetics.json except for those in the node_modules folder). You can also trigger a list of Synthetic tests by specifying a public_id or using a search query.

Complex workflows

Example workflow using the test_search_query

name: Run Synthetic tests by test tag
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.12.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}
          test_search_query: 'tag:e2e-tests'

Example workflow using a test search query and variable overrides

name: Run Synthetic tests using search query
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.12.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}
          test_search_query: 'tag:staging'
          variables: 'START_URL=https://staging.website.com,PASSWORD=stagingpassword'

Example workflow using a global configuration override with config_path

This GitHub Action overrides the path to the global datadog-ci.config.json file.

name: Run Synthetic tests with custom config
jobs:
  e2e_testing:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Run Datadog Synthetic tests
        uses: DataDog/synthetics-ci-github-action@v0.12.0
        with:
          api_key: ${{secrets.DD_API_KEY}}
          app_key: ${{secrets.DD_APP_KEY}}
          config_path: './synthetics-config.json'

For an example test file, see this global.config.json file.

Inputs

Development

yarn test

# Build project
yarn build

# Compile project and its dependencies for release
yarn package

Release Process

To release a new version of synthetics-ci-github-action:

1. Create a new branch for the version upgrade.

2. Update the package version using yarn version [--patch|--minor|--major] depending on the nature of your changes. See Semantic Versioning to determine what you need to increment. Once the yarn version command is done, a new commit vX.Y.Z along with a new tag should be added to the Git tree.

3. Update the README.md example versions, and build and package the project with yarn build && yarn package.

   Make sure to commit these changes within the same commit that holds the vX.Y.Z tag. You can use git commit --amend or git rebase -i HEAD~2 to merge the changes into the same commit.

4. Push the branch along with the release tag (git push --tags) to the upstream (GitHub).

   Create a pull request with the changes introduced in the description. This pull request requires at least one approval.

5. Merge the pull request.

6. Create a GitHub Release from the Tags page with a description of your changes.

⚠️ Ensure the release version follows the expected format vX.Y.Z.

Once the release is created, the new version of the Github Action is available as a workflow.

Further reading

Additional helpful documentation, links, and articles:

• Continuous Testing and CI/CD Configuration
• Best practices for continuous testing with Datadog