https://github.com/greenbone/mattermost-notify

A CLI to post GitHub workflow messages to mattermost
https://github.com/greenbone/mattermost-notify

automation base cli devops github github-actions mattermost python

Last synced: 3 months ago
JSON representation

A CLI to post GitHub workflow messages to mattermost

• Host: GitHub
• URL: https://github.com/greenbone/mattermost-notify
• Owner: greenbone
• License: gpl-3.0
• Created: 2022-05-09T18:02:57.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2026-01-14T09:57:44.000Z (3 months ago)
• Last Synced: 2026-01-14T13:47:22.467Z (3 months ago)
• Topics: automation, base, cli, devops, github, github-actions, mattermost, python
• Language: Python
• Homepage:
• Size: 701 KB
• Stars: 2
• Watchers: 16
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)

# mattermost-notify 

[![GitHub releases](https://img.shields.io/github/release/greenbone/mattermost-notify.svg)](https://github.com/greenbone/mattermost-notify/releases)

[![PyPI release](https://img.shields.io/pypi/v/mattermost-notify.svg)](https://pypi.org/project/mattermost-notify/)

[![code test coverage](https://codecov.io/gh/greenbone/mattermost-notify/branch/main/graph/badge.svg)](https://codecov.io/gh/greenbone/mattermost-notify)

[![Build and test](https://github.com/greenbone/mattermost-notify/actions/workflows/ci-python.yml/badge.svg)](https://github.com/greenbone/mattermost-notify/actions/workflows/ci-python.yml)

This tool is desired to post messages to a mattermost channel.

You will need a mattermost webhook URL and give a channel name.

## Table of Contents 

- [Installation](#installation)

  - [Requirements](#requirements)

  - [Install using pip](#install-using-pip)

- [Usage](#usage)

- [License](#license)

## Installation

### Requirements

Python 3.7 and later is supported.

### Install using pip

pip 19.0 or later is required.

You can install the latest stable release of **mattermost-notify** from the Python

Package Index (pypi) using [pip]

    python3 -m pip install --user mattermost-notify

## Usage

Print a free text message:

```

mnotify-git   --free "What a pitty!"

```

Print a github workflow status:

```

mnotify-git   -S [success, failure, warning] -r  -b  -w  -n 

```

## License

Copyright (C) 2021-2022 Jaspar Stach

Licensed under the [GNU General Public License v3.0 or later](LICENSE).