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 |
Create repositories |
Find issues |
Comment issues |
Find pull requests |
Create pull requests |
Create branches |
List releases |
List commits |
Read files |
Create files |
Update files |
Manage gists |
List workflows |
Toggle 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 gist |
Create issue comment |
Create or update file contents |
Create pull request |
Create repository |
Create workflow dispatch |
Disable workflow |
Enable workflow |
Get commit |
Get current user |
Get issue |
Get issue assignees |
Get repository |
Get repository content |
Get workflow run |
List commits |
List organization repositories |
List organizations |
List releases |
List repositories |
List workflow runs |
Search issues and pull requests |
Star repo |
Sync fork branch with upstream |
Update gist |
Update project v2 item status |
Update pull request |
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:
Your Sana workspace admin has enabled this integration – if the workspace admin has disabled the integration it won't appear in the list of available integrations.
Step 1: Go to the integrations page in Sana
In Sana, click on ... More in the sidebar, then select Integrations
Step 2: Find GitHub in the list of available integrations
Scroll to the Available integrations section and locate GitHub.
Step 3: Connect the integration
Click the integration card and select "Connect just for me", this will open a pop-up powered by Pipedream. Follow the steps in the pop-up to complete the set-up.
Step 4: 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 5: Complete the set up
You've successfully connected your GitHub account. Click Continue to complete the setup and start using the connector.
Known limitations
Issues: The connector cannot change the status of an issue, only edit other metadata.
Branches: The connector cannot list or search branches.