Bart\GitHook\GitHookConfig::README PHP Method

README() public method

public README ( ) : string
return string Sample of how configuration is intended to be defined
    public function README()
    {
        return <<<README
[general]
; Used to determine which refs to run git hooks on. Full ref must be specified.
valid_refs = 'refs/heads/master'

[pre_receive]
hook_actions = '\\Bart\\GitHook\\StopTheLineTravis'

[post_receive]
hook_actions = '\\Bart\\GitHook\\JiraComment', '\\Bart\\GitHook\\GerritAbandon'

[jira]
; Used by JiraComment Hook Action
; %s will be replaced with commit revision hash
comment_template = 'Commit %s pushed to JIRA. See online at https://git.example.com/?h=%s'

[notifications]
; Optional email address to notify when emergencies are pushed
emergency_notification_email = [email protected]
subject = 'Emergency push notification'
body = 'An emergency change has been pushed out.'

README;
    }