Skip to main content
Use GitHub when your workflow needs repository, issue, pull request, or workflow-run actions. It fits steps that create, update, find, or review code collaboration work.

​
Configuration

Before you configure this step, connect GitHub in Integrations for your workspace using the sign-in flow. If no active connection is available, the step shows a warning with a link to Integrations instead of the account selector.

​
Arguments form

When you select an action, the Arguments section renders a form driven by the action’s input schema. Switch to the Raw JSON tab when you prefer to write the full arguments object by hand. Changes in either tab stay in sync.

​
Common actions

Destructive actions, such as deleting records, are not available in the workflow action picker.

​
Output

This step stores the GitHub response as the step output. The shape of the response depends on the action. Use the full output reference in later steps:

​
Example

  1. Open Integrations and connect GitHub if you have not already done that.
  2. Add a GitHub step to your workflow.
  3. Select a connected account in Authentication.
  4. Choose Create issue in Action.
  5. Fill in the required fields. Use Insert Variable to reference an earlier step’s output for any field value.
  6. Click Run in the step header to test the action, then review the returned payload in Output.

​
Use cases

​
Triage a new bug report

  1. Create issue
  2. Add labels
  3. Add assignees

​
Review a pull request

  1. Get pull request
  2. Request reviewers
  3. Mark pull request ready

​
Close resolved work

  1. List repository issues
  2. Close issue
  3. Create issue comment

​
Notes

  • This step depends on a connected GitHub integration in your workspace.
  • The workflow action picker shows a curated set of actions. Agents with the GitHub tool can use more of them.
  • The sign-in screen may show third-party authorization branding.

​
Using GitHub as an Agent Tool

You can also add GitHub as a tool in the Agent Editor. Open the agent, click Add tool, and select GitHub. In the tool settings panel, choose the connected account the agent should use. The agent calls GitHub actions when they are relevant to the conversation. See also: Integrations, Creating and Editing, and Testing and Iteration