Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 3.47 KB

README.md

File metadata and controls

58 lines (36 loc) · 3.47 KB
Raw

Disclaimer

This repository is community supported and not maintained by Mattermost. Mattermost disclaims liability for integrations, including Third Party Integrations and Mattermost Integrations. Integrations may be modified or discontinued at any time.

Mattermost Todo Plugin

Build Status Code Coverage Release HW

A plugin to track Todo issues in a list and send you daily reminders about your Todo list.

Help Wanted

Install

  1. Go the releases page and download the latest release.
  2. On your Mattermost, go to System Console -> Plugin Management and upload it.
  3. Start using it!

Usage

To add an issue to your Todo list, do one one of the following:

  • Open the sidebar from the channel header and click the "Add new issue" button
  • Type /todo add <your Todo message here> into the textbox and send
  • Click the on the dropdown menu from a post and click "Add Todo"

To view your Todo list, do one of the following:

  • Click on the button in the channel header to open the Todo list in the right sidebar.
  • Type /todo list into the textbox and send

To remove an issue from your list:

  • Open the sidebar from the channel header and click the "Done" or "Won't Do" buttons below the issue you want to remove
  • Type /todo pop into the text and send to remove the top issue in the list

To send an issue to another user:

  • Open the sidebar from the channel header and click the "Add new issue" button and select the user you want to send the issue to
  • Type /todo send <username> <your Todo message here> into the textbox and send

Every day you will get a reminder of the issues you need to complete from the Todo bot. The message is only sent if you have issues on your Todo list.

Development

This plugin contains both a server and web app portion. Read our documentation about the Developer Workflow and Developer Setup for more information about developing and extending plugins.

Releasing new versions

The version of a plugin is determined at compile time, automatically populating a version field in the plugin manifest:

  • If the current commit matches a tag, the version will match after stripping any leading v, e.g. 1.3.1.
  • Otherwise, the version will combine the nearest tag with git rev-parse --short HEAD, e.g. 1.3.1+d06e53e1.
  • If there is no version tag, an empty version will be combined with the short hash, e.g. 0.0.0+76081421.

To disable this behaviour, manually populate and maintain the version field.