PHP Class Bart\GitHook\GitHookSystemConfig

Inheritance: extends Bart\Configuration\Configuration
Datei anzeigen Open project: box/bart Class Usage Examples

Public Methods

Method Description
README ( ) : string
envVarNameForPushUser ( ) : PhpOption\Option
frozenRepoNames ( ) : string[]
superUserNames ( ) : string[] Super users are users to whom the frozen status does not apply Typically, this has been used for automation & admins

Method Details

README() public method

public README ( ) : string
return string Sample of how configuration is intended to be defined

envVarNameForPushUser() public method

public envVarNameForPushUser ( ) : PhpOption\Option
return PhpOption\Option [string] Name of environment variable capturing name of user performing `git push`

frozenRepoNames() public method

public frozenRepoNames ( ) : string[]
return string[] Names of repositories configured to be frozen

superUserNames() public method

Super users are users to whom the frozen status does not apply Typically, this has been used for automation & admins
public superUserNames ( ) : string[]
return string[] List of super users