Skip to main content

Announce changes in keepachangelog-style CHANGELOG.md files to Slack

Project description

announcer

This tool:

  • takes an keepachangelog-style CHANGELOG.md file
  • extracts all changes for a particular version
  • and sends a formatted message to a Slack webhook.

Installation

Install this tool using pip:

pip install announcer

Tool usage

usage: announce [-h] --slackhook SLACKHOOK --changelogversion CHANGELOGVERSION
                --changelogfile CHANGELOGFILE --projectname PROJECTNAME
                [--username USERNAME]
                [--iconurl ICONURL | --iconemoji ICONEMOJI]

Announce CHANGELOG changes on Slack

optional arguments:
  -h, --help            show this help message and exit
  --slackhook SLACKHOOK
                        The incoming webhook URL
  --changelogversion CHANGELOGVERSION
                        The changelog version to announce (e.g. 1.0.0)
  --changelogfile CHANGELOGFILE
                        The file containing changelog details (e.g.
                        CHANGELOG.md)
  --projectname PROJECTNAME
                        The name of the project to announce (e.g. announcer)
  --username USERNAME   The username that the announcement will be made as
                        (e.g. qs-announcer)
  --iconurl ICONURL     A URL to use for the user icon in the announcement
  --iconemoji ICONEMOJI
                        A Slack emoji code to use for the user icon in the
                        announcement (e.g. party_parrot)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

announcer-2.2.0.tar.gz (6.1 kB view hashes)

Uploaded source

Built Distribution

announcer-2.2.0-py3-none-any.whl (6.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page