headsnet/deploy-notify-bundle

Send notifications for Symfony application deployment

v0.1.11 2019-05-05 15:44 UTC

Requires

• php: >=7.0
• michelf/php-markdown: ^1.7
• psr/log: ^1.0
• symfony/console: ^3.3 || ~4.0
• symfony/framework-bundle: ^3.0 || ~4.0
• symfony/swiftmailer-bundle: ^2.3 || ^3.0
• twig/twig: ^2.0

MIT

• Ben Roberts

README

Send email notifications to one or more recipients using a simple console command that can be executed by your deployment process.

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

Installation

Install with Composer

composer require headsnet/deployment-notification-bundle

Add bundle to AppKernel.php

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

Configuration

Add required configuration in app/config.yml

headsnet_deploy_notify:
  app_name: My Application
  email:
    sender_email: [e-mail]
  recipients:
    - { name: Joe Bloggs, email: [e-mail] }
    - { name: John Smith, email: [e-mail] }

You can optionally include a change log file in the email template. Just specify the name of the change log file:

headsnet_deploy_notify:
  changelog:
    filename: CHANGES.md

Markdown files ending with a .md extension will automatically be parsed in to HTML.

Usage

Simply execute the console command from your chosen deployment system.

bin/console headsnet:deploy:notify

Configuration Reference

headsnet_deploy_notify:
	app_name:                 ~  # Required
	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: ~ }

Contributing

Contributions are welcome. Please submit via pull requests.