This is an integration module for The Bug Genie issue tracker. It allows posting information about TBG events to your Mattermost team channels.
You can setup the integration on a per-project basis. The following events are supported at the time being:
- Creation of an issue
- Updating issue fields
- Commenting to an issue
- Creation of new releases
- A running The Bug Genie installation, v4.2+
- PHP 5.6+
- Composer
REMARKS: Replace thebuggenie
within the examples with your path to your The Bug Genie installation.
Clone this repository either straight into a folder under thebuggenie/modules/mattermost
,
download the sources and extract them to thebuggenie/modules/mattermost
, or symlink the
sources to the same folder (IMPORTANT: The folder name under thebuggenie/modules MUST be
mattermost
, as The Bug Genie requires the module folder to match the module name):
cd thebuggenie/modules git clone [email protected]:shoreless-ltd/tbg-mattermost.git mattermost
This module uses the composer packages, which must be installed after you installed the module to The Bug Genie.
Navigate to the thebuggenie/modules/mattermost
folder and install the
composer dependencies:
cd thebuggenie/modules/mattermost composer install
You can now enable the module from the configuration section in The Bug Genie.
After activating the module, head over to the settings of the project you like to integrate into your Mattermost channel. Under '''Other Project Details > Mattermost integration''' you can setup your Mattermost webhook URL and channel and decide which TBG events should be announced to your channel.
To create a webhook URL for your Mattermost team channel, please follow the guides in the Mattermost Developer Docs.
If you find any issues or have a suggestion for further development, please
report them in the GitHub issue tracker:
https://github.com/shoreless-ltd/tbg-mattermost/issues