GitHub

Overview

Integrate Github into the workflow. Can get get PR details, create PR comment, get repository info, and get latest commit. Can be used in trigger mode to trigger a workflow when a PR is created, commented on, or a commit is pushed.

How to automate GitHub with Sim

1. 01

   Create a free account

   Sign up at sim.ai in seconds. No credit card required. Your workspace is ready immediately.

2. 02

   Add a GitHub block

   Open a workflow, drag a GitHub block onto the canvas, and paste in your GitHub API key.

3. 03

   Configure, connect, and run

   Pick the tool you need, wire in an AI agent for reasoning or data transformation, and run. Your GitHub automation is live.

Real-time triggers

Connect a GitHub webhook to Sim and your workflow fires the instant an event happens — no polling, no delay. Sim receives the full event payload and makes every field available as a variable inside your workflow.

• Event

  GitHub Issue Opened

  Trigger workflow when a new issue is opened in a GitHub repository

• Event

  GitHub Issue Closed

  Trigger workflow when an issue is closed in a GitHub repository

• Event

  GitHub Issue Comment

  Trigger workflow when a comment is added to an issue (not pull requests)

• Event

  GitHub PR Opened

  Trigger workflow when a new pull request is opened in a GitHub repository

• Event

  GitHub PR Closed

  Trigger workflow when a pull request is closed without being merged (e.g., abandoned) in a GitHub repository

• Event

  GitHub PR Merged

  Trigger workflow when a pull request is successfully merged in a GitHub repository

• Event

  GitHub PR Comment

  Trigger workflow when a comment is added to a pull request in a GitHub repository

• Event

  GitHub PR Reviewed

  Trigger workflow when a pull request review is submitted, edited, or dismissed in a GitHub repository

• Event

  GitHub Push

  Trigger workflow when code is pushed to a repository

• Event

  GitHub Release Published

  Trigger workflow when a new release is published in a GitHub repository

• Event

  GitHub Actions Workflow Run

  Trigger workflow when a GitHub Actions workflow run is requested, in progress, or completed

Workflow templates

Ready-to-use workflows featuring GitHub. Click any to build it instantly.

• GitHub→GitHub

  PR review assistant

  Try this workflow →

• GitHub→GitHub

  Changelog generator

  Try this workflow →

• GitHub→GitHub→Notion→Linear

  Documentation auto-updater

  Try this workflow →

• GitHub→GitHub→Linear→Slack

  Weekly team digest

  Try this workflow →

• GitHub→GitHub→Jira→Microsoft Teams

  Microsoft Teams daily brief

  Try this workflow →

Supported tools

83 GitHub tools available in Sim

• Get PR details

  Fetch PR details including diff and files changed

• Create PR comment

  Create comments on GitHub PRs

• Get repository info

  Retrieve comprehensive GitHub repository metadata including stars, forks, issues, and primary language. Supports both public and private repositories with optional authentication.

• Get latest commit

  Retrieve the latest commit from a GitHub repository

• Create issue comment

  Create a comment on a GitHub issue

• List issue comments

  List all comments on a GitHub issue

• Update comment

  Update an existing comment on a GitHub issue or pull request

• Delete comment

  Delete a comment on a GitHub issue or pull request

• List PR comments

  List all review comments on a GitHub pull request

• Create pull request

  Create a new pull request in a GitHub repository

• Update pull request

  Update an existing pull request in a GitHub repository

• Merge pull request

  Merge a pull request in a GitHub repository

• List pull requests

  List pull requests in a GitHub repository

• Get PR files

  Get the list of files changed in a pull request

• Close pull request

  Close a pull request in a GitHub repository

• Request PR reviewers

  Request reviewers for a pull request

• Get file content

  Get the content of a file from a GitHub repository. Supports files up to 1MB. Content is returned decoded and human-readable.

• Create file

  Create a new file in a GitHub repository. The file content will be automatically Base64 encoded. Supports files up to 1MB.

• Update file

  Update an existing file in a GitHub repository. Requires the file SHA. Content will be automatically Base64 encoded. Supports files up to 1MB.

• Delete file

  Delete a file from a GitHub repository. Requires the file SHA. This operation cannot be undone through the API.

• Get directory tree

  Get the contents of a directory in a GitHub repository. Returns a list of files and subdirectories. Use empty path or omit to get root directory contents.

• List branches

  List all branches in a GitHub repository. Optionally filter by protected status and control pagination.

• Get branch

  Get detailed information about a specific branch in a GitHub repository, including commit details and protection status.

• Create branch

  Create a new branch in a GitHub repository by creating a git reference pointing to a specific commit SHA.

• Delete branch

  Delete a branch from a GitHub repository by removing its git reference. Protected branches cannot be deleted.

• Get branch protection

  Get the branch protection rules for a specific branch, including status checks, review requirements, and restrictions.

• Update branch protection

  Update branch protection rules for a specific branch, including status checks, review requirements, admin enforcement, and push restrictions.

• Create issue

  Create a new issue in a GitHub repository

• Update issue

  Update an existing issue in a GitHub repository

• List issues

  List issues in a GitHub repository. Note: This includes pull requests as PRs are considered issues in GitHub

• Get issue

  Get detailed information about a specific issue in a GitHub repository

• Close issue

  Close an issue in a GitHub repository

• Add issue labels

  Add labels to an issue in a GitHub repository

• Remove issue label

  Remove a label from an issue in a GitHub repository

• Add issue assignees

  Add assignees to an issue in a GitHub repository

• Create release

  Create a new release for a GitHub repository. Specify tag name, target commit, title, description, and whether it should be a draft or prerelease.

• Update release

  Update an existing GitHub release. Modify tag name, target commit, title, description, draft status, or prerelease status.

• List releases

  List all releases for a GitHub repository. Returns release information including tags, names, and download URLs.

• Get release

  Get detailed information about a specific GitHub release by ID. Returns release metadata including assets and download URLs.

• Delete release

  Delete a GitHub release by ID. This permanently removes the release but does not delete the associated Git tag.

• List workflows

  List all workflows in a GitHub repository. Returns workflow details including ID, name, path, state, and badge URL.

• Get workflow

  Get details of a specific GitHub Actions workflow by ID or filename. Returns workflow information including name, path, state, and badge URL.

• Trigger workflow

  Trigger a workflow dispatch event for a GitHub Actions workflow. The workflow must have a workflow_dispatch trigger configured. Returns 204 No Content on success.

• List workflow runs

  List workflow runs for a repository. Supports filtering by actor, branch, event, and status. Returns run details including status, conclusion, and links.

• Get workflow run

  Get detailed information about a specific workflow run by ID. Returns status, conclusion, timing, and links to the run.

• Cancel workflow run

  Cancel a workflow run. Returns 202 Accepted if cancellation is initiated, or 409 Conflict if the run cannot be cancelled (already completed).

• Rerun workflow

  Rerun a workflow run. Optionally enable debug logging for the rerun. Returns 201 Created on success.

• List projects

  List GitHub Projects V2 for an organization or user. Returns up to 20 projects with their details including ID, title, number, URL, and status.

• Get project

  Get detailed information about a specific GitHub Project V2 by its number. Returns project details including ID, title, description, URL, and status.

• Create project

  Create a new GitHub Project V2. Requires the owner Node ID (not login name). Returns the created project with ID, title, and URL.

• Update project

  Update an existing GitHub Project V2. Can update title, description, visibility (public), or status (closed). Requires the project Node ID.

• Delete project

  Delete a GitHub Project V2. This action is permanent and cannot be undone. Requires the project Node ID.

• Search code

  Search for code across GitHub repositories. Use qualifiers like repo:owner/name, language:js, path:src, extension:py

• Search commits

  Search for commits across GitHub. Use qualifiers like repo:owner/name, author:user, committer:user, author-date:>2023-01-01

• Search issues

  Search for issues and pull requests across GitHub. Use qualifiers like repo:owner/name, is:issue, is:pr, state:open, label:bug, author:user

• Search repositories

  Search for repositories across GitHub. Use qualifiers like language:python, stars:>1000, topic:react, user:owner, org:name

• Search users

  Search for users and organizations on GitHub. Use qualifiers like type:user, type:org, followers:>1000, repos:>10, location:city

• List commits

  List commits in a repository with optional filtering by SHA, path, author, committer, or date range

• Get commit

  Get detailed information about a specific commit including files changed and stats

• Compare commits

  Compare two commits or branches to see the diff, commits between them, and changed files

• Create gist

  Create a new gist with one or more files

• Get gist

  Get a gist by ID including its file contents

• List gists

  List gists for a user or the authenticated user

• Update gist

  Update a gist description or files. To delete a file, set its value to null in files object

• Delete gist

  Delete a gist by ID

• Fork gist

  Fork a gist to create your own copy

• Star gist

  Star a gist

• Unstar gist

  Unstar a gist

• Fork repository

  Fork a repository to your account or an organization

• List forks

  List forks of a repository

• Create milestone

  Create a milestone in a repository

• Get milestone

  Get a specific milestone by number

• List milestones

  List milestones in a repository

• Update milestone

  Update a milestone in a repository

• Delete milestone

  Delete a milestone from a repository

• Add issue reaction

  Add a reaction to an issue

• Remove issue reaction

  Remove a reaction from an issue

• Add comment reaction

  Add a reaction to an issue comment

• Remove comment reaction

  Remove a reaction from an issue comment

• Star repository

  Star a repository

• Unstar repository

  Remove star from a repository

• Check if starred

  Check if you have starred a repository

• List stargazers

  List users who have starred a repository

Frequently asked questions