Skip to content

Latest commit

 

History

History
35 lines (19 loc) · 3.82 KB

README.md

File metadata and controls

35 lines (19 loc) · 3.82 KB
Raw

Mattermost Incident Collaboration

Build Status Code Coverage Release

Mattermost Incident Collaboration allows your team to coordinate, manage, and resolve incidents from within Mattermost. For configuration and administration information visit our documentation.

Mattermost Incident Collaboration

License

This repository is licensed under the Mattermost Source Available License and requires a valid Enterprise Edition E20 license when used for production. See frequently asked questions to learn more.

Although a valid Mattermost Enterprise Edition E20 license is required if using this plugin in production, the Mattermost Source Available License allows you to compile and test this plugin in development and testing environments without a Mattermost Enterprise Edition E20 license. As such, we welcome community contributions to this plugin.

On startup, the plugin checks for a valid Mattermost Enterprise Edition E20 license. If you're running an Enterprise Edition of Mattermost and don't already have a valid license, you can obtain a trial license from System Console > Edition and License. If you're running the Team Edition of Mattermost, including when you run the server directly from source, you may instead configure your server to enable both testing (ServiceSettings.EnableTesting) and developer mode (ServiceSettings.EnableDeveloper). These settings are not recommended in production environments. See Contributing to learn more about how to set up your development environment.

Generating test data

To quickly test Mattermost Incident Collaboration, use the following test commands to create incidents populated with random data:

  • /incident test create-incident [playbook ID] [timestamp] [incident name] - Provide the ID of an existing playbook to which the current user has access, a timestamp, and an incident name. The command creates an ongoing incident with the creation date set to the specified timestamp.

    • An example command looks like: /incident test create-incident 6utgh6qg7p8ndeef9edc583cpc 2020-11-23 PR-Testing

  • /incident test bulk-data [ongoing] [ended] [start date] [end date] [seed] - Provide a number of ongoing and ended incidents, a start and end date, and an optional random seed. The command creates the given number of ongoing and ended incidents, with creation dates randomly between the start and end dates. The seed may be used to reproduce the same outcome on multiple invocations. Incident names are generated randomly.

    • An example command looks like: /incident test bulk-data 10 3 2020-01-31 2020-11-22 2

Contributing

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.

For more information about contributing to Mattermost, and the different ways you can contribute, see https://www.mattermost.org/contribute-to-mattermost.