GitHubRepoForker
Forks a GitHub repository from an issue URL.
Basic Information
- Type:
haystack_integrations.github.src.haystack_integrations.components.connectors.github.repo_forker.GitHubRepoForker
Inputs
| Parameter | Type | Default | Description |
|---|---|---|---|
| url | str | GitHub issue URL |
Outputs
| Parameter | Type | Default | Description |
|---|---|---|---|
| repo | str | Dictionary containing repository path in owner/repo format | |
| issue_branch | str | Dictionary containing repository path in owner/repo format |
Overview
Work in Progress
Bear with us while we're working on adding pipeline examples and most common components connections.
Forks a GitHub repository from an issue URL.
The component takes a GitHub issue URL, extracts the repository information, creates or syncs a fork of that repository, and optionally creates an issue-specific branch.
Usage Example
components:
GitHubRepoForker:
type: github.src.haystack_integrations.components.connectors.github.repo_forker.GitHubRepoForker
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 |
| raise_on_failure | bool | True | If True, raises exceptions on API errors |
| wait_for_completion | bool | False | If True, waits until fork is fully created |
| max_wait_seconds | int | 300 | Maximum time to wait for fork completion in seconds |
| poll_interval | int | 2 | Time between status checks in seconds |
| auto_sync | bool | True | If True, syncs fork with original repository if it already exists |
| create_branch | bool | True | If True, creates a fix branch based on the issue number |
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 |
Was this page helpful?