Interface: GithubCreateOrUpdatePrOptions<TIn, TOut>
Defined in: github/src/builders/github-create-or-update-pr-options.ts:12
Configuration options for the GitHub pull-request step builder (github.createOrUpdatePr).
Binds the target repository, API token, synchronous input-to-PR field projections, and optional initial input/output Zod validation schemas.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
TIn | unknown | Step input payload type projected into pull request fields. |
TOut | unknown | Step output payload type validated on step completion. |
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
baseBranch? | readonly | BivariantCallback<[input: TIn], string> | Optional synchronous projection deriving the target base branch name from TIn. | github/src/builders/github-create-or-update-pr-options.ts:20 |
body | readonly | BivariantCallback<[input: TIn], string> | Synchronous projection deriving the pull request markdown body from TIn. | github/src/builders/github-create-or-update-pr-options.ts:24 |
branch | readonly | BivariantCallback<[input: TIn], string> | Synchronous projection deriving the source feature branch name from TIn. | github/src/builders/github-create-or-update-pr-options.ts:18 |
inputSchema? | readonly | ZodType<TIn, unknown, $ZodTypeInternals<TIn, unknown>> | Optional Zod schema validating the step input payload. | github/src/builders/github-create-or-update-pr-options.ts:26 |
outputSchema? | readonly | ZodType<TOut, unknown, $ZodTypeInternals<TOut, unknown>> | Optional Zod schema validating the step output payload. | github/src/builders/github-create-or-update-pr-options.ts:28 |
repo | readonly | string | GitHub repository slug in owner/repo format. | github/src/builders/github-create-or-update-pr-options.ts:14 |
title | readonly | BivariantCallback<[input: TIn], string> | Synchronous projection deriving the pull request title from TIn. | github/src/builders/github-create-or-update-pr-options.ts:22 |
token | readonly | string | EnvRef | GitHub API token or symbolic P.env(...) reference. | github/src/builders/github-create-or-update-pr-options.ts:16 |