Symfony Deployment Notifications

Send email notifications to one or more recipients using a simple console command that can be executed by your deployment process., _(*1)

The notification can be sent to one or more recipients, and can optionally include the application change log file in the email content., _(*2)

Installation

Install with Composer, _(*3)

composer require headsnet/deployment-notification-bundle, _(*4)

Add bundle to AppKernel.php, _(*5)

public function registerBundles()
{
    $bundles = array(
        // ...
        new Headsnet\DeployNotifyBundle\HeadsnetDeployNotifyBundle(),
    );
}

Configuration

Add required configuration in app/config.yml, _(*6)

headsnet_deploy_notify:
  app_name: My Application
  email:
    sender_email: app@domain.com
  recipients:
    - { name: Joe Bloggs, email: joe@email.com }
    - { name: John Smith, email: john@example.com }

You can optionally include a change log file in the email template. Just specify the name of the change log file:, _(*7)

headsnet_deploy_notify:
  changelog:
    filename: CHANGES.md

Markdown files ending with a .md extension will automatically be parsed in to HTML., _(*8)

You can also override the mailer used to send the mails with your own service., _(*9)

headsnet_deploy_notify:
  mailer: swiftmailer.mailer.my_mailer

Usage

Simply execute the console command from your chosen deployment system., _(*10)

bin/console headsnet:deploy:notify, _(*11)

Configuration Reference

headsnet_deploy_notify:
    app_name:                 ~  # Required
    mailer:                   swiftmailer.mailer.default
    email:
        sender_email:         ~  # Required
        sender_name:          '' # Optional
        subject:              'Deployment Notification'
    changelog:
        filename:             ~  # If specified, changelog contents will be included in email
        path:                 /  # Default is project root dir
        public_url:           ~  # Optionally add link to changelog in email
    recipients:
        - { name: ~, email: ~ }
        - { name: ~, email: ~ }