Overview
This node integrates with the GitHub API to work with GitHub issues and issue comments. It allows users to consume data related to issues and their comments from GitHub repositories. Typical use cases include automating issue tracking, monitoring new or updated issues, managing issue comments, or integrating GitHub issue data into other workflows such as project management or reporting tools.
For example, a user might set up this node to automatically fetch all open issues from a repository and then trigger further actions like sending notifications or updating a database.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating with GitHub API. Options: "Access Token" or "OAuth2". |
Note: The node also supports selecting a Resource (Issue or Issue Comment) and various operations on those resources, but since only the default resource and operation were requested, only the authentication property is listed here.
Output
The node outputs JSON data representing GitHub issues or issue comments depending on the selected resource and operation. The output structure corresponds to the GitHub API response for issues or comments, typically including fields such as issue title, body, state, labels, comments, user information, timestamps, and more.
If binary data were involved (e.g., attachments), it would be summarized accordingly, but this node primarily deals with JSON data representing GitHub entities.
Dependencies
- Requires access to the GitHub API.
- Requires an API authentication token, either via a personal Access Token or OAuth2 credentials.
- The node expects proper configuration of these credentials within n8n to authenticate requests to GitHub.
Troubleshooting
- Authentication errors: If the node fails due to authentication, verify that the provided Access Token or OAuth2 credentials are valid and have sufficient permissions (scopes) to access issues and comments.
- API rate limits: GitHub enforces rate limits on API usage. Exceeding these limits will cause errors; consider using authenticated requests and handling rate limit responses gracefully.
- Resource or operation not found: Ensure the selected resource and operation exist and are supported by the node.
- Network issues: Connectivity problems can cause request failures; check network settings and GitHub service status.