Maintainer's Corner

Readme for mattermost-api-40600.0.0

mattermost-api

Client side API for communicating with a Mattermost server, in Haskell.

Testing

We use the MaterMost docker image for detecting changes in the API. See
.travis.yml or the Mattermost
docs
for the details.

If you are testing your changes locally during development, you will want to run
the script ./test/local_test_mm.sh.

Note: The local_test_mm.sh script will stop and remove a docker container
named mattermost-preview.

Note: The tests can only be run once against a given Mattermost instance. This
is because the scripts currently assume they can create an initial admin user.

Note: The scripts assume the instance is reachable on localhost:8065 over plain
HTTP.

For use in production we use TLS, but for testing purposes we avoid the
certificate setup.

Our Versioning Scheme

This library uses the same versioning scheme as matterhorn, see Our
Versioning
Scheme.
The short version is that in ABBCC.X.Y, the ABBCC corresponds to Mattermost
server version A.BB.CC and the X.Y portion of the version string corresponds
to the version of mattermost-api package releases.