Skip to main content
Version: 8.x

Cimonitor Recipe

require 'contrib/cimonitor.php';

Source

Monitor your deployments on CIMonitor. CIMonitorGif Add tasks on deploy:

before('deploy', 'cimonitor:notify');
after('deploy:success', 'cimonitor:notify:success');
after('deploy:failed', 'cimonitor:notify:failure');

Configuration​

  • cimonitor_webhook – CIMonitor server webhook url, required 
    set('cimonitor_webhook', 'https://cimonitor.enrise.com/webhook/deployer');
  • cimonitor_title – the title of application, default the username\reponame combination from {{repository}} 
    set('cimonitor_title', '');
  • cimonitor_user – User object with name and email, default gets information from git config 
    set('cimonitor_user', function () {
      return [
        'name' => 'John Doe',
        'email' => 'john@enrise.com',
      ];
    });

Various cimonitor statusses are set, in case you want to change these yourselves. See the CIMonitor documentation for the usages of different states.

Usage​

If you want to notify only about beginning of deployment add this line only:

before('deploy', 'cimonitor:notify');

If you want to notify about successful end of deployment add this too:

after('deploy:success', 'cimonitor:notify:success');

If you want to notify about failed deployment add this too:

after('deploy:failed', 'cimonitor:notify:failure');

Configuration​

cimonitor_title​

Source

Title of project based on git repo

Default value
$repo = get('repository');
$pattern = '/\w+\/\w+/';
return preg_match($pattern, $repo, $titles) ? $titles[0] : $repo;

cimonitor_user​

Source

Default value
return [
'name' => runLocally('git config --get user.name'),
'email' => runLocally('git config --get user.email'),
];

cimonitor_status_info​

Source

CI monitor status states and job states

Default value
'info'

cimonitor_status_warning​

Source

Default value
'warning'

cimonitor_status_error​

Source

Default value
'error'

cimonitor_status_success​

Source

Default value
'success'

cimonitor_job_state_info​

Source

Default value
get('cimonitor_status_info')

cimonitor_job_state_pending​

Source

Default value
'pending'

cimonitor_job_state_running​

Source

Default value
'running'

cimonitor_job_state_warning​

Source

Default value
get('cimonitor_status_warning')

cimonitor_job_state_error​

Source

Default value
get('cimonitor_status_error')

cimonitor_job_state_success​

Source

Default value
get('cimonitor_status_success')

Tasks​

cimonitor:notify​

Source

Notifies CIMonitor.

cimonitor:notify:success​

Source

Notifies CIMonitor about deploy finish.

cimonitor:notify:failure​

Source

Notifies CIMonitor about deploy failure.