https://github.com/dataesr/mm-notifier-action
This actions allows to send a message in Mattermost channels in a github actions pipeline
https://github.com/dataesr/mm-notifier-action
Last synced: 5 months ago
JSON representation
This actions allows to send a message in Mattermost channels in a github actions pipeline
- Host: GitHub
- URL: https://github.com/dataesr/mm-notifier-action
- Owner: dataesr
- License: mit
- Created: 2022-11-29T04:33:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-07T17:06:44.000Z (over 2 years ago)
- Last Synced: 2025-09-11T10:27:31.191Z (9 months ago)
- Language: JavaScript
- Size: 10.2 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mm-notifier-action
This actions allows to send a message in a Mattermost channel in a github action pipeline. It uses github workflow context to display a formatted message on a selected Mattermost channel.
## Inputs
| Name | Required | Description |
| ---- | -------- | ----------- |
| **github_token** | _required_ | Your github token. Usually use `${{ secrets.GITHUB_TOKEN }}`.
| **mattermost_webhook_url** | _required_ | Your webhook url. Set it as a secret and use it as `${{ secrets.MATTERMOST_WEBHOOK_URL }}`
| **mattermost_channel** | _required_ | A mattermost channel to publish the message.
| **deployment_url** | _optional_ | If provided, adds a link to an app deployment. **Default**: ""
*Only printed if workflow is successfull*
## Usage
```yaml
name: Production deployment
on: [push]
jobs:
hello_job1:
runs-on: ubuntu-latest
name: A job to say hello 1
steps:
- run: echo 'hello'
hello_job2:
runs-on: ubuntu-latest
name: A job to say hello 2
steps:
- run: echo 'hello'
hello_world_job:
needs:
- hello_job1
- hello_job2
if: always()
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: dataesr/mm-notifier-action@v1
with:
deployment_url: ''
github_token: ${{ secrets.GITHUB_TOKEN}}
mattermost_channel: ''
mattermost_webhook_url: ${{ secrets.MATTERMOST_WEBHOOK_URL }}
```