GitHub

GitHub is online source code hosting service for Git projects.

kawasemi uses one of the REST API v3 for sending notification to GitHub.

Settings

Please refer to this page on how to obtain a token.

config = {
    "CHANNELS": {
        "github": {
            "_backend": "kawasemi.backends.github.GitHubChannel",
            # Token
            "token": "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890",
            # Owner of the repository
            "owner": "ymyzk",
            # Repository
            "repository": "test-repo"
        }
    }
}

Options

You can specify all options available in the REST API v3. For instance:

kawasemi.send("Issue Title", options={
    "github": {
        "body": """## ToDo
- [ ] Introduce A
- [ ] Refactor B""",
        "milestone": 123,
        "labels": ["enhancement"],
        "assignees": ["ymyzk"]
    }
})