Skip to main content

GitHub

J
Written by Johan Åkerman

Prerequisite: Third-party connectors are available only on the Sana Enterprise tier, with one exception: the Workday connector is included for both Sana Core and Sana Enterprise.

Introduction

Connect GitHub to Sana to search and manage issues, pull requests, repositories, and workflows. Stay on top of your development work with context from your connected apps.

In summary, the connector has the following key characteristics:

  • Category: Engineering

  • Connector type: Real-time

  • Auth type: OAuth

  • Hosting type: Managed

Capabilities

This connector is able to do the following:

Capability

List repositories

Find issues

Create issues

Update issues

Comment issues

Find pull requests

Create pull requests

Merge pull requests

Review pull requests

Create branches

List branches

List commits

Read files

Create files

Update files

List workflows

Run workflows

Tools

While the capabilities above describe what the connector can do at a high level, the underlying tools show exactly which operations the agent can use when you ask Sana about GitHub. In practice, the agent may call one or more tools to achieve a single capability.

Tool

Create branch

Create issue

Create issue comment

Create or update file contents

Create pull request

Create pull request review

Get commit

Get current user

Get issue

Get pull request

Get pull request files

Get repository

Get repository content

Get workflow run

List branches

List commits

List repositories

List workflow runs

List workflows

Merge pull request

Run workflow

Search issues and pull requests

Update issue

Update pull request

Note: This article lists the connector's full set of tools. Your workspace owner can disable individual tools for your workspace, so some of those listed here may not be available to your agents. If a tool you expected is missing, reach out to your workspace owner.

Triggers

While tools are the actions an agent takes on your behalf, triggers are the events that can start an agent automatically. When you build an agent, you can choose one of the triggers below as its starting point. For example, having the agent run every time something new happens in GitHub.

Trigger

New Branch Created

New Card in Column (Classic Projects)

New Collaborator

New Commit

New Commit Comment

New Discussion

New Fork

New Gist

New Issue Comment

New Label

New Mention

New Notification

New or Updated Issue

New or Updated Milestone

New or Updated Pull Request

New Organization

New release

New Repository

New Review Request

New Security Alert

New Star By User

New Stars

New Team

New Webhook Event (Instant)

New Workflow Job Completed (Instant)

New Workflow Run Completed (Instant)

Project Item Status Changed

Scope and permissions

This connector uses OAuth. When you connect your account, you will need to sign into your account and grant the required permissions:

Scope

Purpose

repo

Read and write access to repositories

read:org

Read organization membership and teams

admin:org_hook

Manage organization webhooks

gist

Create and update your gists

project

Manage and update GitHub Projects

notifications

Read and mark notifications

read:user

Read your public and profile information

write:discussion

Create and edit GitHub Discussions

admin:repo_hook

Manage repository webhooks

Set up instructions

Prerequisites:

  • You are a Sana Enterprise user – all third-party connectors except the Workday connector are available only for users on the Sana Enterprise tier.

  • Your Sana workspace owner has enabled this connector – if the workspace owner has disabled the connector it won't appear in the list of available connectors.

Step 1: Go to the connectors page in Sana

In Sana, click on your profile icon and name in the bottom left corner and select Connectors.

Step 2: Find GitHub in the list of available connectors

Scroll to the Available connectors section and locate GitHub.

Note: If you can't find a connector in this list, it means one of the following:

  1. You've already connected it — check the ”Active connectors” section at the top of the connectors page, or

  2. Your workspace owner has disabled this connector for your workspace — reach out to them for more information or to request that it be enabled.

Step 3: Hover the connector card and click the connect button

Hover the GitHub card and click the Connect button.

Tip: If you click the card itself instead of the Connect button, you'll open a connector detail page with more information about its capabilities.

Step 4: Initialize the Pipedream connection

When clicking Connect in the previous step, a pop-up will appear powered by Pipedream. Click the Continue button in the pop-up to initialize the set up.

Note: Sana uses Pipedream to connect your account. Pipedream is a Workday product, trusted by millions of people to keep their data secure.

Step 5: Sign in to GitHub and approve the requested scopes

You'll be redirected to GitHub to go through their OAuth flow. Sign in and approve the scopes Sana needs to operate the connector.

Step 6: Complete the set up

You've successfully connected your GitHub account. Click Continue to complete the setup and start using the connector.

Known limitations

  • Branches: The connector can list branches but searching them is limited.

Did this answer your question?