GitHubPRCreator
A Haystack component for creating pull requests from a fork back to the original repository.
Basic Information
- Type:
haystack_integrations.github.src.haystack_integrations.components.connectors.github.pr_creator.GitHubPRCreator
Inputs
| Parameter | Type | Default | Description |
|---|---|---|---|
| issue_url | str | URL of the GitHub issue to link the PR to | |
| title | str | Title of the pull request | |
| branch | str | Name of the branch in your fork where changes are implemented | |
| base | str | Name of the branch in the original repo you want to merge into | |
| body | str | Additional content for the pull request description | |
| draft | bool | False | Whether to create a draft pull request |
Outputs
| Parameter | Type | Default | Description |
|---|---|---|---|
| result | str | Dictionary containing operation result |
Overview
Work in Progress
Bear with us while we're working on adding pipeline examples and most common components connections.
A Haystack component for creating pull requests from a fork back to the original repository.
Uses the authenticated user's fork to create the PR and links it to an existing issue.
Usage Example
components:
GitHubPRCreator:
type: github.src.haystack_integrations.components.connectors.github.pr_creator.GitHubPRCreator
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 authentication (from the fork owner) |
| raise_on_failure | bool | True | If True, raises exceptions on API errors |
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 |
|---|---|---|---|
| issue_url | str | URL of the GitHub issue to link the PR to | |
| title | str | Title of the pull request | |
| branch | str | Name of the branch in your fork where changes are implemented | |
| base | str | Name of the branch in the original repo you want to merge into | |
| body | str | Additional content for the pull request description | |
| draft | bool | False | Whether to create a draft pull request |
Was this page helpful?