Announce changes in keepachangelog-style CHANGELOG.md files to Slack and Microsoft Teams
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 or Microsoft Teams webhook.
It is available as a Python package, or as a Docker container for use in CI.
Installation
Install this tool using pip:
pip install announcer
Tool usage
usage: announce [-h] (--webhook WEBHOOK | --slackhook WEBHOOK) [--target {slack,teams}] --changelogversion CHANGELOGVERSION --changelogfile CHANGELOGFILE --projectname PROJECTNAME [--username USERNAME] [--iconurl ICONURL | --iconemoji ICONEMOJI]
Announce CHANGELOG changes on Slack and Microsoft Teams
optional arguments:
-h, --help show this help message and exit
--webhook WEBHOOK The incoming webhook URL
--slackhook WEBHOOK The incoming webhook URL. (Deprecated)
--target {slack,teams}
The type of announcement that should be sent to the webhook
--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. announcer). Valid for: Slack
--iconurl ICONURL A URL to use for the user icon in the announcement. Valid for: Slack
--iconemoji ICONEMOJI
An emoji code to use for the user icon in the announcement (e.g. party_parrot). Valid for: Slack
Gitlab Usage
Announcer builds and publishes a Docker image that you can integrate into your .gitlab-ci.yml
:
announce:
stage: announce
image: metaswitch/announcer:3.0.0
script:
- announce --webhook <webhook address>
--changelogversion $CI_COMMIT_REF_NAME
--changelogfile <CHANGELOG.md file>
--projectname <Project name>
--iconemoji party_parrot
only:
- tags
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
announcer-3.0.0.tar.gz
(7.4 kB
view hashes)
Built Distribution
Close
Hashes for announcer-3.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 430da25dd072c8157168ceeb1e5ce973587347e88c650bf0f3c34f43d3db5b05 |
|
MD5 | 21e848b0d7efcf2f6111ff5e702e1a5f |
|
BLAKE2b-256 | 3da0ef446f1c91752c03c378c4a0b0fb32aaf9e10f49bb83c44b963bcf820d9a |