Ntfy Recipe

php

require 'contrib/ntfy.php';

Source

Installing

Require ntfy.sh recipe in your deploy.php file: Setup:

Setup deploy.php Add in header:

php

require 'contrib/ntfy.php';
set('ntfy_topic', 'ntfy.sh/mytopic');

Add in content:

php

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

9.) Sip your coffee

Configuration

ntfy_server – ntfy server url, default ntfy.sh
```
set('ntfy_server', 'ntfy.sh');
```
ntfy_topic – ntfy topic, required
```
set('ntfy_topic', 'mysecrettopic');
```
ntfy_title – the title of the message, default {{application}}

ntfy_text – notification message template

set('ntfy_text', '_{{user}}_ deploying `{{what}}` to *{{where}}*');

ntfy_tags – notification message tags / emojis (comma separated)
```
set('ntfy_tags', `information_source`);
```
ntfy_priority – notification message priority (integer)
```
set('ntfy_priority', 5);
```

ntfy_success_text – success template, default:

set('ntfy_success_text', 'Deploy to *{{where}}* successful');

ntfy_success_tags – success tags / emojis (comma separated)
```
set('ntfy_success_tags', `white_check_mark,champagne`);
```
ntfy_success_priority – success notification message priority

ntfy_failure_text – failure template, default:

set('ntfy_failure_text', 'Deploy to *{{where}}* failed');

ntfy_failure_tags – failure tags / emojis (comma separated)
```
set('ntfy_failure_tags', `warning,skull`);
```
ntfy_failure_priority – failure notification message priority

Usage

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

php

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

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

php

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

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

php

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

Configuration

ntfy_server

Source

php

'ntfy.sh'

ntfy_title

Source

Title of project

php

return get('application', 'Project');

ntfy_text

Source

Deploy message

php

'_{{user}}_ deploying `{{what}}` to *{{where}}*'

ntfy_success_text

Source

php

'Deploy to *{{where}}* successful'

ntfy_failure_text

Source

php

'Deploy to *{{where}}* failed'

ntfy_tags

Source

Message tags

ntfy_success_tags

Source

ntfy_failure_tags

Source

Tasks

ntfy:notify {#ntfy-notify}

Source

Notifies ntfy server.

ntfy:notify:success {#ntfy-notify-success}

Source

Notifies ntfy server about deploy finish.

ntfy:notify:failure {#ntfy-notify-failure}

Source

Notifies ntfy server about deploy failure.