Thanks to visit codestin.com
Credit goes to github.com

Skip to content

moddi3/mattermost-plugin-redmine-link

ci workflow Mutable.ai Auto Wiki

Redmine Link Transform for Mattermost

This plugin enhances the Mattermost experience by transforming Redmine links in messages into rich content. It automatically extracts information from Redmine issues and presents them in an easy-to-read format.

Automatically transforms Redmine issue links in Mattermost messages into a readable format, providing additional information such as issue status, priority, assignee, and other relevant details directly in the chat.

Usage

Include Redmine issue links in your Mattermost messages to see the plugin in action. The plugin needs to be configured before use.

Example

Here's an example of how the plugin transforms Redmine links:

In the transformed message, you can view the issue subject and tracker. Additional details such as status, priority, author, and last update date are available when hovering over the link.

Example of a transfrmed message in Markdown format:

[Defect#3451: Issue Creation Via Email not Working ](https://www.redmine.org/issues/3451 "Assignee: Unassigned
Priority: Normal
Status: Closed
Author: Carlo Camerino
Last update: Fri, 16 Jul 2021 15:42:40 EEST")

Carriage Return 
 is used to insert a newline character in the link's title attribute. This allows the additional information (Assignee, Priority, Status, Author, Last update) to be displayed on separate lines when the user hovers over the link or views it in a Markdown renderer that supports tooltips.

Installation

While you have the option to build the plugin yourself, it is much easier to download the already built plugin from the releases page of the GitHub repository. Once downloaded, follow the Mattermost documentation on plugin installation to install the plugin in your Mattermost server.

Building Package

  1. Clone the repository: git clone https://github.com/moddi3/mattermost-plugin-redmine-link
  2. Build the plugin: make build
  3. Follow the Mattermost documentation on plugin installation to install the plugin in your Mattermost server.

Configuration

After installation, configure the plugin in the Mattermost System Console:

  • Redmine Instance URL: Specify the URL of your Redmine instance.
  • Redmine API Key (optional): Add your Redmine API key to allow the plugin to fetch issue data (only if you are using private redmine instance).

Documentation

For more detailed documentation and usage instructions, visit the wiki page.

Contributing

Contributions are welcome! Please see the CONTRIBUTING file for guidelines.

License

This plugin is licensed under the MIT License. See the LICENSE file for more details.

Mattermost Starter Plugin Info

For information on getting started with Mattermost plugins, refer to the PLUGIN.md file in the root directory of this repository.

Support

If you encounter any issues or have any questions, please raise them in the GitHub repository issues section.