keven/ci-detect

Port of watson/ci-info NPM module for CI env discovery

Maintainers

Details

github.com/kevengodet/ci-detect

Source

Issues

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.0.1 2024-10-20 22:50 UTC

Requires

  • php: ^8.1

Requires (Dev)

MIT 9b6e6b2abf2fafc7be8754b3051bdb40470e2dd7

  • Keven Godet <hello.woop@keven.fr>

This package is auto-updated.

Last update: 2025-02-20 23:25:22 UTC

README

This library is freely adapted from watson/ci-info npm module.

It detects if PHP is running in a CI environment and which one.

Nearly 50 CI vendors are currently supported.

Installation

$ composer require keven/ci-detect

Usage

<?php

use Keven\CiDetect\Detector;
use Keven\CiDetect\CI;

$vendor = (new Detector)->detect();

$vendor->name; // ex.: Travis CI
$vendor->inPR; // (bool) Are we in a PR?

CI::is('Gitlab'); // (bool) Utility to quickly check a given vendor name

Update vendors

If the library lags behind watson/ci-info in terms of supported vendors, you can update the vendor list by running:

$ php bin/update.php

...which will trigger a synchronization from watson/ci-info repository:

  Download https://raw.githubusercontent.com/watson/ci-info/refs/heads/master/vendors.json
  Update data at data/vendors.php

Declare a vendor or an ENV matching rule

You can declare a new CI vendor manually, for testing purpose, by adding it to data/vendors.php.

Be aware that the file will be overwritten each time you run php bin/update.php.

Please contribute to watson/ci-info to declare vendors for the benefit of everybody.

If matching rules evolve in vendors.json, you can add new matching rules in this package by creating a new class implementing Rule interface.