Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ondram/ci-detector
Detect continuous integration environment and get information of current build
https://github.com/ondram/ci-detector
appveyor build-automation ci ci-info circleci codeship continuous-integration gitlab jenkins php travis travis-ci
Last synced: 3 days ago
JSON representation
Detect continuous integration environment and get information of current build
- Host: GitHub
- URL: https://github.com/ondram/ci-detector
- Owner: OndraM
- License: mit
- Created: 2016-07-29T18:45:37.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-11-28T14:09:10.000Z (24 days ago)
- Last Synced: 2024-12-15T17:08:30.394Z (7 days ago)
- Topics: appveyor, build-automation, ci, ci-info, circleci, codeship, continuous-integration, gitlab, jenkins, php, travis, travis-ci
- Language: PHP
- Homepage:
- Size: 273 KB
- Stars: 214
- Watchers: 4
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# CI Detector
[](https://packagist.org/packages/ondram/ci-detector)
[](https://packagist.org/packages/ondram/ci-detector)
[](https://coveralls.io/r/OndraM/ci-detector)
[](https://github.com/OndraM/ci-detector/actions)
[](https://app.travis-ci.com/OndraM/ci-detector)
[](https://ci.appveyor.com/project/OndraM/ci-detector)
PHP library to detect continuous integration environment and to read information of the current build.
## Why
This library is useful if you need to detect whether some CLI script/tool is running in an automated environment (on a CI server).
Based on that, your script may behave differently. For example, it could hide some information which relevant only for
a real person - like a progress bar.
Additionally, you may want to detect some information about the current build: build ID, git commit, branch etc.
For example, if you'd like to record these values to log, publish them to Slack, etc.
## How
The detection is based on environment variables injected to the build environment by each CI server.
However, these variables are named differently in each CI. This library contains adapters for many supported
CI servers to handle these differences, so you can make your scripts (and especially CLI tools) portable to multiple
build environments.
## Supported continuous integration servers
These CI servers are currently recognized:
- [AppVeyor][appveyor]
- [AWS CodeBuild][aws-codebuild]
- [Azure DevOps Pipelines][azure-pipelines]
- [Bamboo][bamboo]
- [Bitbucket Pipelines][bitbucket]
- [Buddy][buddy]
- [CircleCI][circleci]
- [Codeship][codeship]
- continuousphp
- [drone][drone]
- [GitHub Actions][github-actions]
- [GitLab][gitlab]
- [Jenkins][jenkins]
- [SourceHut][sourcehut]
- [TeamCity][teamcity]
- [Travis CI][travis-ci]
- Wercker
If your favorite CI server is missing, feel free to send a pull-request!
## Installation
Install using [Composer](https://getcomposer.org/):
```sh
$ composer require ondram/ci-detector
```
## Example usage
```php
isCiDetected()) { // Make sure we are on CI environment
echo 'You are running this script on CI server!';
$ci = $ciDetector->detect(); // Returns class implementing CiInterface or throws CiNotDetectedException
// Example output when run inside GitHub Actions build:
echo $ci->getCiName(); // "GitHub Actions"
echo $ci->getBuildNumber(); // "33"
echo $ci->getBranch(); // "feature/foo-bar" or empty string if not detected
// Conditional code for pull request:
if ($ci->isPullRequest()->yes()) {
echo 'This is pull request. The target branch is: ';
echo $ci->getTargetBranch(); // "main"
}
// Conditional code for specific CI server:
if ($ci->getCiName() === OndraM\CiDetector\CiDetector::CI_GITHUB_ACTIONS) {
echo 'This is being built on GitHub Actions';
}
// Describe all detected values in human-readable form:
print_r($ci->describe());
// Array
// (
// [ci-name] => GitHub Actions
// [build-number] => 33
// [build-url] => https://github.com/OndraM/ci-detector/commit/abcd/checks
// [commit] => fad3f7bdbf3515d1e9285b8aa80feeff74507bde
// [branch] => feature/foo-bar
// [target-branch] => main
// [repository-name] => OndraM/ci-detector
// [repository-url] => https://github.com/OndraM/ci-detector
// [is-pull-request] => Yes
// )
} else {
echo 'This script is not run on CI server';
}
```
## API methods reference
Available methods of `CiInterface` instance (returned from `$ciDetector->detect()`):
| Method | Example value | Description |
|-----------------------|-------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `getCiName()` | `GitHub Actions` | Name of the CI server.
The value is one of `CiDetector::CI_*` constants. |
| `getBuildNumber()` | `33` | Get number of this concrete build.
Build number is usually human-readable increasing number sequence. It should increase each time this particular job was run on the CI server. Most CIs use simple numbering sequence like: 1, 2, 3... However, some CIs do not provide this simple human-readable value and rather use for example alphanumeric hash. |
| `getBuildUrl()` | `https://github.com/OndraM/ci-detector/commit/abcd/checks`
or empty string | Get URL where this build can be found and viewed or empty string if it cannot be determined. |
| `getCommit()` | `b9173d94(...)` | Get hash of the git (or other VCS) commit being built. |
| `getBranch()` | `my-feature`
or empty string | Get name of the git (or other VCS) branch which is being built or empty string if it cannot be determined.
Use `getTargetBranch()` to get name of the branch where this branch is targeted. |
| `getTargetBranch()` | `main`
or empty string | Get name of the target branch of a pull request or empty string if it cannot be determined.
This is the base branch to which the pull request is targeted. |
| `getRepositoryName()` | `OndraM/ci-detector`
or empty string | Get name of the git (or other VCS) repository which is being built or empty string if it cannot be determined.
This is usually in form "user/repository", for example `OndraM/ci-detector`. |
| `getRepositoryUrl()` | `https://github.com/OndraM/ci-detector`
or empty string | Get URL where the repository which is being built can be found or empty string if it cannot be determined.
This is either HTTP URL like `https://github.com/OndraM/ci-detector` but may be a git ssh url like `ssh://[email protected]/OndraM/ci-detector` |
| `isPullRequest()` | `TrinaryLogic` instance | Detect whether current build is from a pull/merge request.
Returned `TrinaryLogic` object's value will be true if the current build is from a pull/merge request, false if it not, and maybe if we can't determine it (see below for what CI supports PR detection).
Use condition like `if ($ci->isPullRequest()->yes()) { /*...*/ }` to use the value. |
| `describe()` | `[...]`
(array of values) | Return key-value map of all detected properties in human-readable form. |
## Supported properties of each CI server
Most CI servers support (✔) detection of all information. However some don't expose
necessary environment variables, thus reading some information may be unsupported (❌).
| CI server | Constant of `CiDetector` | `isPullRequest` | `getBranch` | `getTargetBranch` | `getRepositoryName` | `getRepositoryUrl` | `getBuildUrl` |
|------------------------------------|--------------------------|------------------|--------------|---------------------|-----------------------|----------------------|-----------------|
| [AppVeyor][appveyor] | `CI_APPVEYOR` | ✔ | ✔ | ✔ | ✔ | ❌ | ✔ |
| [AWS CodeBuild][aws-codebuild] | `CI_AWS_CODEBUILD` | ✔ | ✔ | ❌ | ❌ | ✔ | ✔ |
| [Azure Pipelines][azure-pipelines] | `CI_AZURE_PIPELINES` | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| [Bamboo][bamboo] | `CI_BAMBOO` | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| [Bitbucket Pipelines][bitbucket] | `CI_BITBUCKET_PIPELINES` | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| [Buddy][buddy] | `CI_BUDDY` | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| [CircleCI][circleci] | `CI_CIRCLE` | ✔ | ✔ | ❌ | ✔ | ✔ | ✔ |
| [Codeship][codeship] | `CI_CODESHIP` | ✔ | ✔ | ❌ | ✔ | ❌ | ✔ |
| continuousphp | `CI_CONTINUOUSPHP` | ✔ | ✔ | ❌ | ❌ | ✔ | ✔ |
| [drone][drone] | `CI_DRONE` | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| [GitHub Actions][github-actions] | `CI_GITHUB_ACTIONS` | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| [GitLab][gitlab] | `CI_GITLAB` | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
| [Jenkins][jenkins] | `CI_JENKINS` | ❌ | ✔ | ❌ | ❌ | ✔ | ✔ |
| [SourceHut][sourcehut] | `CI_SOURCEHUT` | ✔ | ❌ | ❌ | ❌ | ❌ | ✔ |
| [TeamCity][teamcity] | `CI_TEAMCITY` | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| [Travis CI][travis-ci] | `CI_TRAVIS` | ✔ | ✔ | ✔ | ✔ | ❌ | ✔ |
| Wercker | `CI_WERCKER` | ❌ | ✔ | ❌ | ✔ | ❌ | ✔ |
## Testing
Check codestyle, static analysis and run unit-tests:
```sh
composer all
```
To automatically fix codestyle violations run:
```sh
composer fix
```
## Standalone CLI version
If you want to use CI Detector as a standalone CLI command (ie. without using inside code of PHP project),
see [ci-detector-standalone](https://github.com/OndraM/ci-detector-standalone) repository, where you can
download CI Detector as a standalone PHAR file with simple command line interface.
## Changelog
For latest changes see [CHANGELOG.md](CHANGELOG.md) file. This project follows [Semantic Versioning](https://semver.org/).
## Similar libraries for other languages
Similar "CI Info" libraries exists for some other languages, for example:
- Go - [KlotzAndrew/ci-info](https://github.com/KlotzAndrew/ci-info)
- JavaScript/Node.js - [watson/ci-info](https://github.com/watson/ci-info)
- Python - [mgxd/ci-info](https://github.com/mgxd/ci-info)
- Rust - [sagiegurari/ci_info](https://github.com/sagiegurari/ci_info)
[appveyor]: https://www.appveyor.com/
[aws-codebuild]: https://aws.amazon.com/codebuild/
[azure-pipelines]: https://azure.microsoft.com/en-us/products/devops/pipelines
[bamboo]: https://www.atlassian.com/software/bamboo
[bitbucket]: https://bitbucket.org/product/features/pipelines
[buddy]: https://buddy.works/
[circleci]: https://circleci.com/
[codeship]: https://codeship.com/
[drone]: https://drone.io/
[github-actions]: https://github.com/features/actions
[gitlab]: https://about.gitlab.com/solutions/continuous-integration/
[jenkins]: https://www.jenkins.io/
[sourcehut]: https://sourcehut.org/
[teamcity]: https://www.jetbrains.com/teamcity/
[travis-ci]: https://travis-ci.org/