https://github.com/cpfriend1721994/fastlane-plugin-mattermost
Fastlane plugin for push messages to Mattermost
https://github.com/cpfriend1721994/fastlane-plugin-mattermost
fastlane fastlane-plugins mattermost mattermost-plugin rubygem
Last synced: 8 months ago
JSON representation
Fastlane plugin for push messages to Mattermost
- Host: GitHub
- URL: https://github.com/cpfriend1721994/fastlane-plugin-mattermost
- Owner: cpfriend1721994
- License: mit
- Created: 2020-07-01T04:04:12.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-09T03:41:01.000Z (almost 3 years ago)
- Last Synced: 2025-04-12T14:40:37.347Z (8 months ago)
- Topics: fastlane, fastlane-plugins, mattermost, mattermost-plugin, rubygem
- Language: Ruby
- Homepage: https://rubygems.org/gems/fastlane-plugin-mattermost
- Size: 117 KB
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mattermost plugin
[](https://rubygems.org/gems/fastlane-plugin-mattermost)
## Getting Started
1. Generate `Mattermost Incoming Webhook`
- From your Mattermost organization page, go to `Integrations` -> `Incoming Webhooks` -> `Add Incoming Webhooks`
- Configurate Incoming Webhooks
- Get Webhooks URL
2. Add plugin to `fastlane`
```bash
fastlane add_plugin mattermost
```
3. Add `mattermost` to your lane in `Fastfile`, for more infomations about incoming webhook's fields read: https://developers.mattermost.com/integrate/incoming-webhooks/
```bash
lane :build_android do
...
# Push messages to Mattermost
# Minimum params example
mattermost(
url: "https://example.mattermost.com/hooks/xxx-generatedkey-xxx", # mandatory
text: "Hello, this is some text\nThis is more text. :tada:", # mandatory if 'attachments' is not set
username: "Fastlane Mattermost", # optional
icon_url: "https://www.mattermost.org/wp-content/uploads/2016/04/icon.png" # optional
)
# Full params example
mattermost(
url: "https://example.mattermost.com/hooks/xxx-generatedkey-xxx", # mandatory
text: "Hello, this is some text\nThis is more text. :tada:", # mandatory
username: "Fastlane Mattermost", # optional
icon_url: "https://www.mattermost.org/wp-content/uploads/2016/04/icon.png", # optional
channel: ... , # optional
icon_emoji: ... , # optional
attachments: [...] , # optional
props: ... , # optional
type: ... # optional
)
```
## About mattermost
Fastlane plugin for push messages to Mattermost
**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
## Example
Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
## Run tests for this plugin
To run both the tests, and code style validation, run
```
rake
```
To automatically fix many of the styling issues, use
```
rubocop -a
```
## Issues and Feedback
For any other issues and feedback about this plugin, please submit it to this repository.
## Troubleshooting
If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
## Using _fastlane_ Plugins
For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
## About _fastlane_
_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).