CiEnvironment

This library detects the CI environment based on environment variables defined by CI servers.

If a CI server is detected, a CiEnvironment.json struct is returned:

{
  "name": "...",
  "url": "...",
  "buildNumber": "...", // optional
  "git": {              // optional
    "remote": "...",
    "revision": "...",
    "branch": "...",    // optional
    "tag": "..."        // optional
  }
}

Note that some fields are optional (they may not be set if the corresponding environment variables are not defined).

Some CI servers expose usernames and passwords in the environment variable that is used to detect git.remote. For security reasons, this library removes the username and password from the git.remote field in the CiEnvironment.json struct.

TypeScript

npm install @cucumber/ci-environment

import detectCiEnvironment from '@cucumber/ci-environment'

const ciEnvironment = detectCiEnvironment(process.env)
console.log(JSON.stringify(ciEnvironment, null, 2))

Java

<dependency>
    <groupId>io.cucumber</groupId>
    <artifactId>ci-environment</artifactId>
</dependency>

import static io.cucumber.cienvironment.DetectCiEnvironment.detectCiEnvironment;

public class CiEnvironmentExample {
    public static void main(String[] args) {
        CiEnvironment ciEnvironment = detectCiEnvironment(System.getenv()).orElseThrow(() -> new RuntimeException("No CI environment detected"));
        System.out.println("ciEnvironment = " + ciEnvironment);
    }
}

Ruby

gem 'cucumber-ci-environment'

require 'cucumber/ci_environment'

ci_environment = Cucumber::CiEnvironment.detect_ci_environment(ENV)
p ci_environment

Go

go get github.com/cucumber/ci-environment/go@latest

import (
  "fmt"
	cienvironment "github.com/cucumber/ci-environment/go"
)

func main() {
  ci := cienvironment.DetectCIEnvironment()
  if ci == nil {
    fmt.Println("No CI environment detected")
  }
}

import os
from ci_environment import detect_ci_environment

ci_environment = detect_ci_environment(os.environ)

Supported CI servers

• Azure Pipelines
• Bamboo
• Buddy
• Bitrise
• CircleCI
• CodeFresh
• CodeShip
• GitHub Actions
• GitLab
• GoCD
• Jenkins and Jenkins Git plugin
• JetBrains Space
• Semaphore
• Travis CI
• Wercker

Contributing

Please see CONTRIBUTING.md for more information.