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.3.0.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

announcer-2.3.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file announcer-2.3.0.tar.gz.

File metadata

  • Download URL: announcer-2.3.0.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.16 CPython/3.6.3 Linux/4.4.0-101-generic

File hashes

Hashes for announcer-2.3.0.tar.gz
Algorithm Hash digest
SHA256 fa4b1e46f6a93024e6122350da7278ae6637782bc5a8bfac2d58a8b0eecc7c38
MD5 cdd05b8ee49160898badd603761d78a5
BLAKE2b-256 b9f9cd70af33888560bff4f46a4a692993ba2e4fbcbb5de54ee7c9184f032414

See more details on using hashes here.

File details

Details for the file announcer-2.3.0-py3-none-any.whl.

File metadata

  • Download URL: announcer-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.16 CPython/3.6.3 Linux/4.4.0-101-generic

File hashes

Hashes for announcer-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7e5a37e7f6a8cfc49ac6e42d5efa270f3cd43aa17d0fa5b0158ef3d398d019a
MD5 3a1695db7d7c107cd4a62aac12312325
BLAKE2b-256 0c91d120d3973abe3f05acfc6b6ae75041c314988dacaa281acf631a14886604

See more details on using hashes here.

Supported by

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