Skip to content

Interface: GithubCreateOrUpdatePrNode<TIn, TOut, THandle> ​

Defined in: ast/domain/github-create-or-update-pr-node.ts:15

Passive AST node creating or updating a GitHub pull request (github.createOrUpdatePr).

Idempotently opens a new pull request or updates an existing open pull request for branch against baseBranch in repo.

Extends ​

Type Parameters ​

Type ParameterDefault typeDescription
TInunknownValidated step input type.
TOutunknownValidated step output type.
THandleunknownIsolation scope handle type.

Properties ​

PropertyModifierTypeDescriptionInherited fromDefined in
__handleBrand?readonlyBivariantCallback<[handle: THandle], void>Phantom type brand binding the step to its compatible scope handle type.BaseDomainStepASTNode.__handleBrandast/base/base-domain-step-ast-node.ts:30
baseBranch?readonlyBivariantCallback<[input: TIn], string>Optional pure projection deriving the target base branch name from TIn.-ast/domain/github-create-or-update-pr-node.ts:27
bodyreadonlyBivariantCallback<[input: TIn], string>Pure projection deriving the pull request body from TIn.-ast/domain/github-create-or-update-pr-node.ts:31
branchreadonlyBivariantCallback<[input: TIn], string>Pure projection deriving the head branch name from TIn.-ast/domain/github-create-or-update-pr-node.ts:25
idreadonlystringLogical identifier of the step node.BaseDomainStepASTNode.idast/base/base-domain-step-ast-node.ts:24
inputSchemareadonlyZodType<TIn>Zod schema validating the step's input payload at entry.BaseDomainStepASTNode.inputSchemaast/base/base-domain-step-ast-node.ts:26
outputSchemareadonlyZodType<TOut>Zod schema validating the step's output payload at exit.BaseDomainStepASTNode.outputSchemaast/base/base-domain-step-ast-node.ts:28
reporeadonlystringGitHub repository slug in owner/repo format.-ast/domain/github-create-or-update-pr-node.ts:21
titlereadonlyBivariantCallback<[input: TIn], string>Pure projection deriving the pull request title from TIn.-ast/domain/github-create-or-update-pr-node.ts:29
tokenreadonlystring | EnvRefGitHub API token or symbolic EnvRef.-ast/domain/github-create-or-update-pr-node.ts:23
typereadonly"github:create-or-update-pr"Unique string-literal discriminant of the domain step node.BaseDomainStepASTNode.typeast/base/base-domain-step-ast-node.ts:22

Released under the MIT License.