Skip to content

Issue

Issue is the GitHub component that manages a repository’s issues, the cards where a team records bugs, tasks and requests. With it you can look up one issue or the list of issues, create a new one, change its title, description, state or labels, add a comment, lock or unlock its conversation, and close it.

It is useful when issues start outside GitHub, for example in a support form or a customer’s email, and you want them to reach the technical team without copying them by hand.

When to use it

  • A customer reports a bug through the support form and you want to open an issue with their description.
  • Every morning you want a summary of the open issues with a specific label, for example urgent.
  • An AI agent answers technical questions and needs to check whether a bug is already recorded and comment on the issue.
  • When a case is solved in your support tool, you want to close the matching issue in GitHub.

Configuration

You need a GitHub API credential with a GitHub Personal Access Token that has access to the repository. See Credentials.

FieldWhat it does
Credential (required)The GitHub API credential used to access your account.
Repository Input TypeHow you specify the repository. Select picks it from a list; Manual lets you type it. Default: Select.
Repository (required)With Select. The repository to work with. The list loads when you choose the credential and shows up to 100 repositories from your account; if yours is not there, use Manual.
Repository ID (required)With Manual. The repository in the format owner/repository, for example my-company/website.
Operation (required)What the component does. See Operations. Default: List.
Issue NumberThe issue’s number, shown next to its title in GitHub. Required in every operation except List and Create.
Issue TitleThe issue’s title. Required in Create; in Edit, only if you want to change it.
Issue BodyOnly in Create and Edit. The issue’s description.
Comment Body (required)Only in Create Comment. The text of the comment.

Operations

OperationWhat it does
GetReturns an issue’s details: title, state, description and number of comments.
ListReturns the repository’s list of issues, with the state and label filters you choose.
CreateCreates a new issue and returns its number and link.
EditChanges an issue’s title, description, state or labels.
Create CommentAdds a comment to an issue.
LockLocks an issue’s conversation, marked as resolved, so no more comments can be added.
UnlockReopens the conversation of a locked issue.
DeleteCloses the issue. The issue is not removed: it stays in GitHub with the closed state.

Advanced options

FieldWhat it does
LabelsOnly in List, Create and Edit. Comma-separated labels. In List they filter the issues that have them; in Create and Edit they are assigned to the issue.
StateOnly in List and Edit. all, open or closed. In List it filters by state; in Edit, open reopens the issue and closed closes it (all leaves it unchanged). Default: all.
LimitOnly in List. The maximum number of issues to return, up to 1000. Default: 100.

Output

The Data output depends on the operation:

  • Get: the issue’s number, title, state, description and number of comments.
  • List: one item per issue with its description as text, plus its link, title, author, creation date, number of comments, state, labels, assignee and whether it is locked. GitHub also includes pull requests in this list; each item says whether it is one.
  • Create and Edit: a confirmation with the issue number and its link.
  • Create Comment: a confirmation with the comment’s ID.
  • Lock, Unlock and Delete: a confirmation with the issue number.

You can connect the result to a messaging component to alert the team, or to an agent so it can summarise the issues. The component can also be connected to an Agent as a tool, so the agent decides when to look up, create or comment on issues. See Tool Mode.

Example

A software company wants every bug sent through its support form to reach GitHub.

  1. The form reaches the flow with the subject and description the customer wrote.
  2. Add Issue with the Create operation and pick the product’s repository in Repository.
  3. Connect the subject to Issue Title and the description to Issue Body.
  4. In Labels (advanced options) write support.
  5. Connect the Data output to an email that replies to the customer with the issue link.

Good practices

  • In Edit, always write the full description in Issue Body: what you enter replaces the current description and, if you leave it empty, the issue ends up with no description.
  • Keep the issue number when you create it, for example in your support tool: you need it to comment on, change or close the issue later.
  • Write labels exactly as they appear in GitHub so the List filter finds them.
  • Repository: lists the repositories in your account.
  • Review: work with pull requests and their reviews.
  • File: read and write files in a repository.
  • Release: manage published releases.