README.md

Maunium GitLab bot
==================
A Gitlab bot for Matrix. It uses
[mautrix](https://github.com/tulir/mautrix),
[go-playground webhooks](https://github.com/go-playground/webhooks) and
[go-gitlab](https://github.com/xanzy/go-gitlab)

## Features
* [x] Spam a Matrix room using GitLab webhooks
* [x] Log in to GitLab accounts (per-user)
* [x] Commits
  * [x] View full commit messages
	* [x] View commit diffs
	* [x] View commit history
* [ ] Issue management
	* [x] Read issues
	* [x] Create/close/reopen issues
	* [ ] Read comments on issues
	* [ ] Comment on issues

## Usage
Configure the server by copying `example-config.json` to `config.json` and
filling out the fields.

### Webhooks
When adding a GitLab webhook, add the internal room ID as a query string in the
field `room`. For example, if the address + path is `https://example.com/webhook`,
you could add `https://example.com/webhook?room=!HweXqCwBqJzepVovYt:matrix.org`
as the webhook URL and the bot would send notifications to the room whose
internal ID is `!HweXqCwBqJzepVovYt:matrix.org`.

### Commands
You should log in with your GitLab access token, since most commands require
authentication. You can log in by sending `!gitlab login <access token>` to the
bot in a private room.

The bot only handles commands prefixed with `!gitlab`. Command help page:
```
- ping                  - Ping the bot.
- show <repo> <hash>    - Get details about a specific commit.
- diff <repo> <hash>    - Get the diff of a specific commit.
- log <repo> [n] [page] - Get the log of a specific repo.
- whoami                - Check who you're logged in as.
- logout                - Remove your GitLab access token from storage.
- login <token>         - Add a GitLab access token to storage.
- help                  - Show this help page.
```