GitHub Toolkit
The GitHub Toolkit is a workflow node. Its tools include List Repositories, Get Repository, List Issues, and Create Issue, plus 16 more listed below. Connect a GitHub account before you use any of these tools. Type @ in a field when the value should come from an earlier step.
Authentication
Every GitHub tool needs a connected account before it can run. On the node, open GitHub Account.
- Choose Use my GitHub account or Use team account.
- If no personal account is connected, click Connect GitHub Account and finish sign-in.
- For a team account, choose Use team account and pick one from Team account. The list shows accounts already connected for the project.
Tools
List Repositories
Lists repositories.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Visibility | No | Repository visibility: 'all', 'public', or 'private'. Default is all. Type @ to select a variable. |
| Sort | No | Sort by: 'created', 'updated', 'pushed', 'full_name'. Default is updated. Type @ to select a variable. |
| Direction | No | Sort direction: 'asc' or 'desc'. Default is desc. Type @ to select a variable. |
| Per Page | No | Number of repositories per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Get Repository
Retrieves repository.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
List Issues
Lists issues.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| State | No | Issue state: 'open', 'closed', or 'all'. Default is open. Type @ to select a variable. |
| Labels | No | Comma-separated list of label names. Default is null. Type @ to select a variable. |
| Assignee | No | Username of assignee. Default is null. Type @ to select a variable. |
| Per Page | No | Number of issues per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Create Issue
Creates issue.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Title | Yes | Issue title. Type @ to select a variable. |
| Body | No | Issue description/body. Default is null. Type @ to select a variable. |
| Labels | No | List of label names. Default is null. |
| Assignees | No | List of usernames to assign. Default is null. |
List Pull Requests
Lists pull requests.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| State | No | PR state: 'open', 'closed', or 'all'. Default is open. Type @ to select a variable. |
| Base | No | Base branch name. Default is null. Type @ to select a variable. |
| Created After | No | Filter PRs created on or after this date (ISO format: YYYY-MM-DD). Uses GitHub Search API when set. Default is null. Type @ to select a variable. |
| Created Before | No | Filter PRs created on or before this date (ISO format: YYYY-MM-DD). Uses GitHub Search API when set. Default is null. Type @ to select a variable. |
| Updated After | No | Filter PRs updated on or after this date (ISO format: YYYY-MM-DD). Uses GitHub Search API when set. Default is null. Type @ to select a variable. |
| Updated Before | No | Filter PRs updated on or before this date (ISO format: YYYY-MM-DD). Uses GitHub Search API when set. Default is null. Type @ to select a variable. |
| Sort | No | Sort by: 'created', 'updated', 'popularity'. Default is created. Type @ to select a variable. |
| Direction | No | Sort direction: 'asc' or 'desc'. Default is desc. Type @ to select a variable. |
| Per Page | No | Number of PRs per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Create Pull Request
Creates pull request.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Title | Yes | Pull request title. Type @ to select a variable. |
| Head | Yes | Branch containing changes. Type @ to select a variable. |
| Base | Yes | Branch to merge into. Type @ to select a variable. |
| Body | No | Pull request description. Default is null. Type @ to select a variable. |
Get File Content
Retrieves file content.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Path | Yes | File path in the repository. Type @ to select a variable. |
| Ref | No | Branch name, tag, or commit SHA. Default is null. Type @ to select a variable. |
List Branches
Lists branches.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Per Page | No | Number of branches per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Search Repositories
Searches repositories.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Query | Yes | Search query. Type @ to select a variable. |
| Sort | No | Sort by: 'stars', 'forks', 'help-wanted-issues', 'updated'. Default is best-match. Type @ to select a variable. |
| Order | No | Sort order: 'desc' or 'asc'. Default is desc. Type @ to select a variable. |
| Per Page | No | Number of repositories per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Get Commit History
Retrieves commit history.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Sha | No | SHA or branch to start listing commits from (defaults to repository's default branch). Default is null. Type @ to select a variable. |
| Path | No | Only commits containing this file path will be returned. Default is null. Type @ to select a variable. |
| Author | No | GitHub login or email address to filter commits by author. Default is null. Type @ to select a variable. |
| Since | No | Only show commits after this date (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ). Default is null. Type @ to select a variable. |
| Until | No | Only show commits before this date (ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ). Default is null. Type @ to select a variable. |
| Per Page | No | Number of commits per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Get Pull Request
Retrieves pull request.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Pull Number | Yes | Pull request number. |
Get Pull Request Files
Retrieves pull request files.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Pull Number | Yes | Pull request number. |
| Per Page | No | Number of files per page (1-300). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Get Pull Request Diff
Retrieves pull request diff.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Pull Number | Yes | Pull request number. |
Get Pull Request Commits
Retrieves pull request commits.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Pull Number | Yes | Pull request number. |
| Per Page | No | Number of commits per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Get Labels
Retrieves labels.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Per Page | No | Number of labels per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Assign Pull Request Labels
Runs the assign pull request labels tool.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Pull Number | Yes | Pull request number. |
| Labels | Yes | List of label names to assign to the pull request. |
Get Pull Request Reviews
Retrieves pull request reviews.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Pull Number | Yes | Pull request number. |
| Per Page | No | Number of reviews per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Get Pull Request Comments
Retrieves pull request comments.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Pull Number | Yes | Pull request number. |
| Per Page | No | Number of comments per page (1-100). Default is 30. |
| Page | No | Page number for pagination. Default is 1. |
Add Pull Request Comment
Adds pull request comment.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Pull Number | Yes | Pull request number. |
| Body | Yes | The comment text to post on the pull request. Type @ to select a variable. |
Create Pull Request Review
Creates pull request review.
| Field | Required | Description |
|---|---|---|
| GitHub Account | Yes | Select your personal or team GitHub account. |
| Owner | Yes | Repository owner's username or organization name. Type @ to select a variable. |
| Repo | Yes | Repository name. Type @ to select a variable. |
| Pull Number | Yes | Pull request number. |
| Body | Yes | The body text of the review. Type @ to select a variable. |
| Event | Yes | The review action: 'APPROVE', 'REQUEST_CHANGES', or 'COMMENT'. Type @ to select a variable. |
| Comments | No | JSON string of line-level comments, each with 'path', 'position', and 'body' keys. Default is null. Type @ to select a variable. |
Related
Agents can use this integration from chat. See GitHub.
See all integrations on the toolkits overview.