GitHub integration

Authentication

Supported authentication methods

Basic authentication

No custom configuration required in GitHub for this type of authentication.

Select "Basic authentication" in the first step of integration wizard. Click "Next".

Select basic authentication

Provide username and password.

Provide authentication info

Basic Authentication & 2-factor authentication

If 2FA is being used, Basic Authentication can not be used, OAuth is the the only option. Once the user authenticates Bugsee to GitHub the integration will continue working as long as the token is valid.

Read more at GitHub: https://developer.github.com/changes/2013-09-03-two-factor-authentication/

OAuth

Select "OAuth" in the first step of integration wizard. Click Next.

Select OAuth

You will be presented with dialog asking you to authorize Bugsee. Click Authorize to allow Bugsee access your GitHub.

OAuth Grant

Configuration

There are no any specific configuration steps for GitHub. Refer to configuration section for description about generic steps.

Custom recipes

Bugsee can accommodate all these customizations with the help of custom recipes. This section provides a few examples of using custom recipes specifically with Github. For basic introduction, refer to custom recipe documentation.

Setting labels field

By default Bugsee creates and updates Github issues with Bugsee issue labels. But labels list can be overridden inside your custom recipe. For example you can add some new label to existing ones:

function create(context) {
    // ....

    return {
        // ...
        labels: [...issue.labels, "My awesome label"]
    };
}

function update(context, changes) {
    const result = {};
    // ...

    if (changes.labels) {
        result.labels = [...changes.labels.to, "My awesome label"];
    }

    return {
        issue: {
            custom: {}
        },
        changes: result
    };
}