Current File : /home/vacivi36/code/vendor/rector/rector/vendor/ondram/ci-detector/src/Ci/CiInterface.php
<?php
declare (strict_types=1);
namespace RectorPrefix202209\OndraM\CiDetector\Ci;
use RectorPrefix202209\OndraM\CiDetector\Env;
use RectorPrefix202209\OndraM\CiDetector\TrinaryLogic;
interface CiInterface
{
/**
* Return true if this CI was detected.
*/
public static function isDetected(Env $env) : bool;
/**
* Get name of the CI server type.
*/
public function getCiName() : string;
/**
* Return key-value map of all detected properties in human-readable form.
*
* @return array<string, string>
*/
public function describe() : array;
/**
* 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.
*/
public function getBuildNumber() : string;
/**
* Get URL where this build can be found and viewed.
*/
public function getBuildUrl() : string;
/**
* Get hash of the git (or other VCS) commit being built.
*/
public function getCommit() : string;
/**
* Get name of the git (or other VCS) branch which is being built.
*
* Use `getTargetBranch()` to get name of the branch where this branch is targeted.
*/
public function getBranch() : string;
/**
* Get name of the target branch of a pull request.
*/
public function getTargetBranch() : string;
/**
* Get name of the git (or other VCS) repository which is being built.
*
* This is usually in form "user/repository", for example "OndraM/ci-detector".
*/
public function getRepositoryName() : string;
/**
* Get URL where the repository which is being built can be found.
*
* This is either HTTP URL like "https://github.com/OndraM/ci-detector"
* but may be a git ssh url like "ssh://git@bitbucket.org/OndraM/ci-detector".
*/
public function getRepositoryUrl() : string;
/**
* 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.
*/
public function isPullRequest() : TrinaryLogic;
}
Mini Shell