CI/CD Integration

Supported pipelines: GitHub Actions, GitLab CI, CircleCI, Jenkins, Bitbucket Pipelines · Requires an API key from your dashboard

GitHub Actions

Use the official BotGauge GitHub Action from the marketplace. Add to your workflow:

name: BotGauge Tests
on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: botgauge/run-action@v1
        with:
          api-key: ${{ secrets.BOTGAUGE_API_KEY }}
          suite: e2e
          fail-on: any

Set BOTGAUGE_API_KEY in your repository secrets at Settings → Secrets → Actions.

GitLab CI

Add to your .gitlab-ci.yml:

botgauge:
  image: botgauge/cli:latest
  stage: test
  script:
    - botgauge run --suite e2e
  variables:
    BOTGAUGE_API_KEY: $BOTGAUGE_API_KEY
  artifacts:
    paths:
      - .botgauge/results/

CircleCI

Add to your .circleci/config.yml:

jobs:
  botgauge-test:
    docker:
      - image: botgauge/cli:latest
    steps:
      - checkout
      - run:
          name: Run BotGauge Tests
          command: botgauge run --suite e2e
          environment:
            BOTGAUGE_API_KEY: << pipeline.parameters.botgauge_key >>

Jenkins

Add a stage to your Jenkinsfile:

stage('BotGauge Tests') {
    steps {
        sh 'docker run --rm \\
            -e BOTGAUGE_API_KEY=${BOTGAUGE_API_KEY} \\
            -v ${WORKSPACE}:/workspace \\
            botgauge/cli:latest run --suite e2e'
    }
}

Environment variables