GitHubIssueCommenter
Posts comments to GitHub issues.
Basic Information
- Type:
haystack_integrations.github.src.haystack_integrations.components.connectors.github.issue_commenter.GitHubIssueCommenter
Inputs
| Parameter | Type | Default | Description |
|---|---|---|---|
| url | str | GitHub issue URL | |
| comment | str | Comment text to post |
Outputs
| Parameter | Type | Default | Description |
|---|---|---|---|
| success | bool | Dictionary containing success status |
Overview
Work in Progress
Bear with us while we're working on adding pipeline examples and most common components connections.
Posts comments to GitHub issues.
The component takes a GitHub issue URL and comment text, then posts the comment to the specified issue using the GitHub API.
Usage Example
components:
GitHubIssueCommenter:
type: github.src.haystack_integrations.components.connectors.github.issue_commenter.GitHubIssueCommenter
init_parameters:
Parameters
Init Parameters
These are the parameters you can configure in Pipeline Builder:
| Parameter | Type | Default | Description |
|---|---|---|---|
| github_token | Secret | Secret.from_env_var('GITHUB_TOKEN') | GitHub personal access token for API authentication as a Secret |
| raise_on_failure | bool | True | If True, raises exceptions on API errors |
| retry_attempts | int | 2 | Number of retry attempts for failed requests |
Run Method Parameters
These are the parameters you can configure for the component's run() method. This means you can pass these parameters at query time through the API, in Playground, or when running a job. For details, see Modify Pipeline Parameters at Query Time.
| Parameter | Type | Default | Description |
|---|---|---|---|
| url | str | GitHub issue URL | |
| comment | str | Comment text to post |
Was this page helpful?