Skip to content

FriendsOfSilverStripe/release-notifications

Repository files navigation

SilverStripe Release Notifications
Build Status Latest Stable Version Latest Unstable Version Scrutinizer Code Quality Total Downloads License

This little helper sends notification emails out, if your CHANGELOG-file has changed.

Requirements

  • SilverStripe Framework 3.x
  • a markdown CHANGELOG.md file in your website source code, during the deployment.

Installation

composer require FriendsOfSilverStripe/release-notifications

Configuration

e.g. mysite/_config/config.yml:

# send the release notification to the team and stakeholders
ReleaseNotification:
  environments:
    test1:
      environment_name: test1
      url: 'http://test1.company.com/'
      filename: CHANGELOG.md
      from: [email protected]
      subject: New Release (TEST)
      recipients:
        - [email protected]
    production:
      environment_name: production
      url: 'http://company.com/'
      filename: CHANGELOG.md
      from: [email protected]
      subject: New Release
      recipients:
        - [email protected]