title: "GitHub" lang: "en-US" draft: false description: "Learn about how to set up a VDP GitHub component https://github.com/instill-ai/instill-core"

The GitHub component is an application component that allows users to do anything available on GitHub. It can carry out the following tasks:

• List Pull Requests
• Get Pull Request
• Get Commit
• List Review Comments
• Create Review Comment
• List Issues
• Get Issue
• Create Issue
• Create Webhook

Release Stage

Alpha

Configuration

The component definition and tasks are defined in the definition.json and tasks.json files respectively.

Setup

In order to communicate with GitHub, the following connection details need to be provided. You may specify them directly in a pipeline recipe as key-value pairs within the component's setup block, or you can create a Connection from the Integration Settings page and reference the whole setup as setup: ${connection.<my-connection-id>}.

Supported Tasks

List Pull Requests

Get the list of all pull requests in a repository. Detailed information about each commit in a PR is omitted, please use the Get Commit task or the Get Pull Request task to get the details of a commit.

Get Pull Request

Get a pull request from a repository, given the PR number. This will default to the latest PR if no PR number is provided

Get Commit

Get a commit from a repository, given the commit SHA

List Review Comments

Get the review comments in a pull request. The comments can be on a specific line or on the PR as a whole.

Create Review Comment

Create a review comment in a pull request. The comment can be a general comment or a review comment. The comment can be on a specific line or on the PR as a whole.

List Issues

Get the list of all issues in a repository,This can be a pull request or a general issue, and you can tell by the is-pull-request field.

Get Issue

Get an issue. This can be a pull request or a general issue, and you can tell by the is-pull-request field.

Create Issue

Create an issue

Create Webhook

Create a webhook for a repository

Recipe for the List GitHub Repo Issues pipeline.

version: v1beta
component:
  anthropic-0:
    type: anthropic
    task: TASK_TEXT_GENERATION_CHAT
    input:
      max-new-tokens: 1000
      model-name: claude-3-5-sonnet-20240620
      prompt: Summarise and pick the most important issues from this list ${github.output.issues}
      system-message: You are a helpful assistant.
      temperature: 0.7
      top-k: 10
    setup:
      api-key: ${secret.INSTILL_SECRET}
  github:
    type: github
    task: TASK_LIST_ISSUES
    input:
      direction: desc
      no-pull-request: false
      owner: ${variable.repository-owner}
      page: 1
      per-page: 30
      repository: ${variable.repository-name}
      since: "2021-01-01T00:00:00Z"
      sort: created
      state: open
    setup:
      token: ${secret.github-demo}
variable:
  repository-name:
    title: Repository Name
    description: Name of the repository i.e. instill-core
    instill-format: string
  repository-owner:
    title: Repository Owner
    description: Name of the repository owner i.e. instill-ai
    instill-format: string
output:
  result:
    title: Result
    value: ${anthropic-0.output.text}