@cucumber/ci-environment

What is @cucumber/ci-environment?

@cucumber/ci-environment is a Node.js package designed to detect and provide information about the Continuous Integration (CI) environment in which your code is running. This can be useful for customizing behavior based on the CI environment, such as configuring test runners or reporting tools.

What are @cucumber/ci-environment's main functionalities?

Detect CI Environment

This feature allows you to detect the CI environment and retrieve metadata about it. The `getCIMetadata` function returns an object containing information such as the CI provider, build number, and other relevant details.

const { getCIMetadata } = require('@cucumber/ci-environment');
const ciMetadata = getCIMetadata();
console.log(ciMetadata);

Check if Running in CI

This feature allows you to check if the code is running in a CI environment. The `isCI` boolean flag can be used to conditionally execute code based on whether it is running in a CI environment.

const { isCI } = require('@cucumber/ci-environment');
if (isCI) {
  console.log('Running in a CI environment');
} else {
  console.log('Not running in a CI environment');
}

Other packages similar to @cucumber/ci-environment

ci-info

The `ci-info` package provides similar functionality by detecting if the code is running in a CI environment and providing metadata about the CI environment. It supports a wide range of CI services and is lightweight and easy to use.

env-ci

The `env-ci` package is another alternative that detects the CI environment and provides metadata. It supports many CI services and offers a simple API for accessing CI-related information. It is comparable to @cucumber/ci-environment in terms of functionality and ease of use.

README

The README file is missing