GitHub Issues icon

GitHub Issues

Consume issues from the GitHub API

Actions4

Overview

This node interacts with GitHub's API to retrieve multiple comments from issues within a specified repository. It is useful for scenarios where you want to analyze, monitor, or process all comments on issues in a GitHub repository, such as aggregating feedback, tracking discussions, or integrating issue comments into other workflows.

For example, you might use this node to:

  • Fetch all comments on issues in a project repository to generate reports.
  • Monitor user feedback and responses on open issues.
  • Integrate issue comments into a customer support system or chat platform.

Properties

Name Meaning
Authentication Method of authenticating with GitHub API. Options: "Access Token" (personal access token) or "OAuth2" (OAuth 2.0 authentication).
Repository Owner The owner of the GitHub repository. Can be selected from a list of users, provided as a GitHub URL (e.g., https://github.com/n8n-io), or entered by name (e.g., n8n-io).
Repository Name The name of the GitHub repository. Can be selected from a list, provided as a GitHub repository URL (e.g., https://github.com/n8n-io/n8n), or entered by name (e.g., n8n).
Return All Boolean flag indicating whether to return all available issue comments or limit the number of results. If false, only up to the specified limit will be returned.
Limit Maximum number of issue comments to return when "Return All" is false. Value range: 1 to 100. Defaults to 50.

Output

The node outputs JSON data representing the retrieved issue comments. Each item in the output corresponds to a single comment on an issue, including details such as the comment body, author, creation date, and associated issue information.

If the node supports binary data output (not indicated here), it would typically represent attachments or media related to comments, but this operation focuses on JSON data.

Dependencies

  • Requires a valid GitHub API authentication credential, either via a personal access token or OAuth2.
  • Needs network access to GitHub's REST API endpoint at https://api.github.com.
  • Uses internal methods to search and validate repository owners and repositories.

Troubleshooting

  • Authentication errors: Ensure that the provided access token or OAuth2 credentials have sufficient permissions to read issue comments in the target repository.
  • Invalid repository or owner: Verify that the repository owner and name are correct and accessible with the given credentials.
  • Rate limiting: GitHub API enforces rate limits; if exceeded, the node may fail. Consider using authenticated requests to increase limits.
  • Pagination issues: When "Return All" is enabled, the node paginates through results. Network interruptions or API changes may cause incomplete data retrieval.
  • Validation errors: Input fields for URLs and names enforce regex validation; ensure inputs conform to expected formats.

Links and References

Discussion