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] [--compatibility-teams-sections] [--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
  --compatibility-teams-sections
                        Compatibility option - sends Teams messages in multiple sections
  --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:5.0.0
  script:
   - announce --webhook <webhook address>
              --changelogversion $CI_COMMIT_REF_NAME
              --changelogfile <CHANGELOG.md file>
              --projectname <Project name>
              --iconemoji party_parrot
  only:
    - tags

Download files

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

Source Distribution

announcer-6.0.1.tar.gz (7.0 kB view details)

Uploaded Mar 11, 2025 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

announcer-6.0.1-py3-none-any.whl (9.5 kB view details)

Uploaded Mar 11, 2025 Python 3

File details

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

File metadata

Download URL: announcer-6.0.1.tar.gz
Upload date: Mar 11, 2025
Size: 7.0 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for announcer-6.0.1.tar.gz
Algorithm	Hash digest
SHA256	`2248c536554c9914987f57d79e20db9d6ee2b6f218365b7de6fd7a27984aaf77`
MD5	`17fcf49ac98dae03ece5ac9de4f6bf0d`
BLAKE2b-256	`66e8c3982251b44afa34be3a5f1ab86e438d353c16a078c9fe9ea8d41a9e5b48`

See more details on using hashes here.

Provenance

The following attestation bundles were made for announcer-6.0.1.tar.gz:

Publisher: deploy.yml on Metaswitch/announcer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: announcer-6.0.1.tar.gz
- Subject digest: 2248c536554c9914987f57d79e20db9d6ee2b6f218365b7de6fd7a27984aaf77
- Sigstore transparency entry: 180353465
- Sigstore integration time: Mar 11, 2025
Source repository:
- Permalink: Metaswitch/announcer@327c16e497b5a4a6667b7b910ff5cf53aa1326e8
- Branch / Tag: refs/tags/6.0.1
- Owner: https://github.com/Metaswitch
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: deploy.yml@327c16e497b5a4a6667b7b910ff5cf53aa1326e8
- Trigger Event: push