hookshot/README.md
Will Hunt d575e5fb2f
Add documentation on various things (#90)
* Add details on webhooks

* More doc things

* More docs

* More documentation changes

* Tidy tidy

* Lots more documentation

* Support defaults for all GitHub configuration options

* Add metrics changes

* s/Added/Add
2021-12-21 16:41:19 +00:00

1.3 KiB

matrix-hookshot

Previously matrix-github

#hookshot:half-shot.uk Docker Image Version (latest by date)

A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA.

Featureset

This bridge bridges:

  • GitHub
    • Webhooks (new issues, pull requests, releases etc)
    • Commands (create issues, assign issues, start workflows etc)
  • GitLab
    • Webhooks (new issues, merge requests etc)
    • Commands
  • Jira
    • Webhooks (new issues, issue changes)
    • Commands (create new issues)
  • Generic webhooks
    • Webhooks (via GET, PUT or POST with optional transformation functions)

Setup

See the setup guide

Documentation

Documentation can be found on GitHub Pages.

You can build the documentaion yourself by:

# cargo install mdbook
mdbook build
sensible-browser book/index.html

Contact

TODO...