friendsofsilverstripe/release-notifications

Checks the CHANGELOG file and sends an email with the diff, if required.

Maintainers

Package info

github.com/FriendsOfSilverStripe/release-notifications

Type:silverstripe-module

pkg:composer/friendsofsilverstripe/release-notifications

Fund package maintenance!

spekulatius

www.buymeacoffee.com/spekulatius

Statistics

Installs: 1 644

Dependents: 0

Suggesters: 0

Stars: 3

Open Issues: 1

Security

Advisories: 0

Aikido package health analysis

0.2.1 2016-07-09 04:33 UTC

Requires

Suggests

BSD-3-Clause c99945a6d3a0e25be772509c55d4a57a8a4c2bba

deploydeploymentsilverstripereleasechangelogrelease processassistentCHANGELOG.md

This package is auto-updated.

Last update: 2026-02-28 07:29:11 UTC

README

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: dev-team@company.com
      subject: New Release (TEST)
      recipients:
        - qa-team@company.com
    production:
      environment_name: production
      url: 'http://company.com/'
      filename: CHANGELOG.md
      from: info@company.com
      subject: New Release
      recipients:
        - info@company.com

misc: future ideas/development, issues, contributing, license