Other CI providers

Use these pipelines to install dependencies and run npx momentic run. Set MOMENTIC_API_KEY in your provider’s secret store. Sharding examples are included for CircleCI, Buildkite, and Azure DevOps. For GitHub Actions and GitLab CI, see GitHub Actions and GitLab CI. More configs live in momentic-ai/examples. Every example assumes momentic is a dev dependency in the root package.json:

package.json

{
  "devDependencies": {
    "momentic": "latest"
  }
}

CircleCI

For CircleCI, create .circleci/config.yml in your repository:

config.yml

version: 2.1
orbs:
  node: circleci/node@5.0.2
workflows:
  test:
    jobs:
      - test
jobs:
  test:
    docker:
      - image: cimg/node:22.12
    steps:
      - checkout
      - node/install-packages

      - run:
          name: Install browsers
          command: npx momentic install-browsers --all

      - run:
          name: Run Momentic tests
          command: npx momentic run
          when: always

      - run:
          name: Upload results
          command: npx momentic results upload test-results
          when: always

CircleCI authentication

Set the MOMENTIC_API_KEY environment variable in your CircleCI project settings.

Create an API key in the Momentic dashboard.

Copy the value. You add it as a CI secret in the next step.

Go to your CircleCI project settings and click the Environment Variables tab. Create a new secret called MOMENTIC_API_KEY and enter your API key.
CircleCI automatically loads environment variables stored in project settings into the CI environment. The CI file needs no changes.

CircleCI sharding

To shard your tests, pass the --shard-index and --shard-count options to the momentic run command. The --shard-index is the index of the current shard (starting from 1), and --shard-count is the total number of shards. To collect test results inside a single run group in the Momentic dashboard, add a separate step after all tests complete to merge and upload results.

config.yml

version: 2.1
orbs:
  node: circleci/node@5.0.2

jobs:
  run-tests:
    parallelism: 2
    docker:
      - image: cimg/node:22.12
    steps:
      - checkout
      - node/install-packages

      - run:
          name: Install browsers
          command: npx momentic install-browsers --all

      - run:
          name: Run tests
          command: |
            mkdir -p test-results/shard-${CIRCLE_NODE_INDEX}
            set +e
            npx momentic run \
              --output-dir test-results/shard-${CIRCLE_NODE_INDEX} \
              --shard-index $(($CIRCLE_NODE_INDEX+1)) \
              --shard-count ${CIRCLE_NODE_TOTAL}
            test_status=$?
            echo "$test_status" > test-results/shard-${CIRCLE_NODE_INDEX}/exit-code

      - store_artifacts:
          path: ./test-results

      - persist_to_workspace:
          root: .
          paths:
            - test-results

      - run:
          name: Restore test exit code
          command: exit "$(cat test-results/shard-${CIRCLE_NODE_INDEX}/exit-code)"

  upload-results:
    docker:
      - image: cimg/node:22.12
    steps:
      - checkout
      - node/install-packages

      - attach_workspace:
          at: .

      - run:
          name: Merge test results
          command: npx momentic results merge --output-dir test-results/merged test-results

      - run:
          name: Upload test results
          command: npx momentic results upload test-results/merged

workflows:
  test:
    jobs:
      - run-tests
      - upload-results:
          requires:
            - run-tests:
              - success
              - failed

Jenkins

Configure a NodeJS tool named NodeJS 22 in Jenkins with Node.js 22.12.0 or later in the 22.x line. Node.js 23 is unsupported. Commit package-lock.json for npm ci, then create this Jenkinsfile:

Jenkinsfile

pipeline {
    agent any

    tools {
        nodejs 'NodeJS 22'
    }

    stages {
        stage('Checkout Code') {
            steps {
                checkout scm
            }
        }

        stage('Install Dependencies') {
            steps {
                sh 'npm ci'
            }
        }

        stage('Install Browsers for Momentic') {
            steps {
                sh 'npx momentic install-browsers --all'
            }
        }

        stage('Run Momentic Tests and Upload Results') {
            steps {
                sh 'npx momentic run'
            }
            post {
                always {
                    sh 'npx momentic results upload test-results'
                }
            }
        }
    }
}

Jenkins authentication

Add the momentic-api-key credential to your Jenkins instance.

Create an API key in the Momentic dashboard.

Copy the value. You add it as a CI secret in the next step.

In Manage Jenkins > Credentials, add a new global credential.
At the top of your Jenkinsfile, provide the following environment variables to the pipeline:

Jenkinsfile

pipeline {
    agent any

    environment {
        MOMENTIC_API_KEY = credentials('momentic-api-key')
    }
}

Travis CI

For Travis CI, create .travis.yml in your repository:

.travis.yml

language: node_js
node_js:
  - "22"
install:
  - npm install
  - npx momentic install-browsers chromium
script:
  - npx momentic run
after_script:
  - npx momentic results upload test-results

Travis CI authentication

Set the MOMENTIC_API_KEY environment variable in your Travis repository settings.

Create an API key in the Momentic dashboard.

Copy the value. You add it as a CI secret in the next step.

Go to your Travis repository settings and scroll down to the Environment Variables section. Create a new variable called MOMENTIC_API_KEY and enter the value of your API key.
Travis CI automatically loads environment variables stored in project settings into the CI environment. The CI file needs no changes.

Buildkite

Run Momentic on Buildkite. Buildkite is auto-detected, so Momentic reads git metadata (branch, commit, pipeline) from the agent. Create a file called .buildkite/pipeline.yml in your repository with the following contents:

.buildkite/pipeline.yml

steps:
  - label: ":momentic: Test"
    commands:
      - npm install
      - npx momentic install-browsers --all
      - npx momentic run --upload-results

Buildkite authentication

To run tests, you must authenticate with Momentic by providing the MOMENTIC_API_KEY environment variable.

Create an API key in the Momentic dashboard.

Copy the value. You add it as a CI secret in the next step.

Store it with the Buildkite secrets tooling your agents use: the secrets Buildkite plugin, your secrets manager, or an agent environment hook. Do not commit it to the pipeline file.
Expose it to the momentic steps as MOMENTIC_API_KEY:

.buildkite/pipeline.yml

steps:
  - label: ":momentic: Test"
    env:
      MOMENTIC_API_KEY: "${MOMENTIC_API_KEY}"
    commands:
      - npm install
      - npx momentic install-browsers --all
      - npx momentic run --upload-results

Buildkite sharding

Buildkite exposes the parallel job index as BUILDKITE_PARALLEL_JOB (0-indexed) and the total as BUILDKITE_PARALLEL_JOB_COUNT. Momentic’s --shard-index is 1-indexed, so add one. To collect every shard into a single run group in the dashboard, add a step that merges and uploads results after the tests finish.

.buildkite/pipeline.yml

steps:
  - label: ":momentic: Test %n"
    parallelism: 4
    artifact_paths:
      - "test-results/**/*"
    commands:
      - npm install
      - npx momentic install-browsers --all
      - |
        npx momentic run \
          --shard-index $(($BUILDKITE_PARALLEL_JOB + 1)) \
          --shard-count $BUILDKITE_PARALLEL_JOB_COUNT \
          --output-dir test-results/shard-$BUILDKITE_PARALLEL_JOB

  - wait: ~
    continue_on_failure: true

  - label: ":momentic: Merge and upload results"
    commands:
      - npm install
      - buildkite-agent artifact download "test-results/**/*" test-results
      - npx momentic results merge --output-dir test-results/merged test-results
      - npx momentic results upload test-results/merged

Buildkite Test Analytics

Momentic can emit a Buildkite-format JSON report with the buildkite-json reporter for Buildkite Test Analytics:

npx momentic run --reporter buildkite-json --reporter-dir reports

Azure DevOps

Run Momentic on Azure Pipelines. Momentic detects Azure DevOps when System.CollectionUri contains azure and reads git metadata from dotted environment variables such as Build.SourceVersion. Create a file called azure-pipelines.yml in your repository with the following contents:

azure-pipelines.yml

trigger:
  - main

pool:
  vmImage: ubuntu-latest

steps:
  - task: NodeTool@0
    inputs:
      versionSpec: "22.x"
    displayName: Install Node.js

  - script: npm install
    displayName: Install dependencies

  - script: npx momentic install-browsers --all
    displayName: Install browsers

  - script: npx momentic run
    displayName: Test
    env:
      MOMENTIC_API_KEY: $(MOMENTIC_API_KEY)

  - script: npx momentic results upload test-results
    displayName: Upload results
    condition: always()
    env:
      MOMENTIC_API_KEY: $(MOMENTIC_API_KEY)

Azure DevOps authentication

To run tests, you must authenticate with Momentic by providing the MOMENTIC_API_KEY environment variable.

Create an API key in the Momentic dashboard.

Copy the value. You add it as a CI secret in the next step.

Add it as a secret pipeline variable named MOMENTIC_API_KEY. Mark it as secret so logs mask it. Do not commit it to the pipeline file.
Azure does not pass secret variables to scripts on its own. Map the variable into the environment of each momentic step with env:, as shown above.

Azure DevOps sharding

Use a parallel job strategy and use the 1-indexed System.JobPositionInPhase and total System.TotalJobsInPhase for --shard-index / --shard-count. To collect every shard into a single run group in the dashboard, add a job that merges and uploads results after the tests finish.

azure-pipelines.yml

trigger:
  - main

pool:
  vmImage: ubuntu-latest

jobs:
  - job: test
    displayName: Run tests
    strategy:
      parallel: 4
    steps:
      - task: NodeTool@0
        inputs:
          versionSpec: "22.x"
      - script: npm install
      - script: npx momentic install-browsers --all
      - script: |
          npx momentic run \
            --shard-index $(System.JobPositionInPhase) \
            --shard-count $(System.TotalJobsInPhase) \
            --output-dir test-results/shard-$(System.JobPositionInPhase)
        displayName: Test
        env:
          MOMENTIC_API_KEY: $(MOMENTIC_API_KEY)
      - publish: test-results
        artifact: test-results-$(System.JobPositionInPhase)
        condition: always()

  - job: merge_results
    displayName: Merge and upload results
    dependsOn: test
    condition: always()
    steps:
      - task: NodeTool@0
        inputs:
          versionSpec: "22.x"
      - script: npm install
      - download: current
      - script: |
          npx momentic results merge --output-dir test-results/merged $(Pipeline.Workspace)
          npx momentic results upload test-results/merged
        displayName: Merge and upload
        env:
          MOMENTIC_API_KEY: $(MOMENTIC_API_KEY)

Get started

Mo

Regression tests

App setup

Write tests

Run tests

Maintain tests

Integrations

Workspace

Migrate and upgrade

Other CI providers

CircleCI

CircleCI authentication

CircleCI sharding

Jenkins

Jenkins authentication

Travis CI

Travis CI authentication

Buildkite

Buildkite authentication

Buildkite sharding

Buildkite Test Analytics

Azure DevOps

Azure DevOps authentication

Azure DevOps sharding