netzmacht/release-notifier

Ths package provides a CLI tool to create release notes of packagist releases.

0.4.0 2019-02-20 16:02 UTC

This package is auto-updated.

Last update: 2022-11-20 15:57:05 UTC


README

This tool allows to notify about releases published on packagist to a broader audience.

You can publish the release information as twitter tweet and as a forum post/topic of a forum using tapatalk.

Requirements

  • >= PHP 7.1

Install

Global installation

  1. Make sure that the composer global bin directory is part of your PATH environment variable.
  2. Install the tool with composer global require netzmacht/release-notifier

Local installation

Alternatively you can install it in any directory locally

  1. Install the tool with composer require netzmacht/release-notifier

Usage

The following description assumes you have installed the tool globally. If you have an local installation you have to adjust the executable path.

  1. Create a configuration file in your current directory
    release-notifier create-config config.php
  2. Edit the configuration file with your publishers and packages.
  3. Check if any new releases where made (since last run). If config is used the first time, it's checked against today.
    release-notifier check -v
  4. Let the tool publish your releases
    release-notifier publish -v
  5. Setup an cron job to automate the task

The tool used the symfony/console. You might use the list command or --help option to get more information about the provides commands.

Twitter

If you want to use the twitter publisher, you have to register an own twitter app and generate the access token online at developer.twitter.com