Class GithubAdapter

Hierarchy (View Summary)

AbstractGitForgeAdapter
- GithubAdapter

Index

Constructors

constructor

new GithubAdapter(context: ForgeContext): GithubAdapter
Parameters
- context: ForgeContext
Returns GithubAdapter
Overrides AbstractGitForgeAdapter.constructor
- Defined in git-github/src/GithubAdapter.ts:31

Properties

`Readonly`context

context: ForgeContext

`Readonly`forgeType

forgeType: ForgeType = "github"

Methods

authStatus

authStatus(): Promise<AuthStatus>
Returns Promise<AuthStatus>
Overrides AbstractGitForgeAdapter.authStatus
- Defined in git-github/src/GithubAdapter.ts:71

createBranch

createBranch(branchName: string, fromBranch?: string): Promise<void>
Parameters
- branchName: string
- fromBranch: string = "main"
Returns Promise<void>
Overrides AbstractGitForgeAdapter.createBranch
- Defined in git-github/src/GithubAdapter.ts:420

downloadBlob

downloadBlob(sha: string): Promise<string>
Parameters
- sha: string
Returns Promise<string>
Overrides AbstractGitForgeAdapter.downloadBlob
- Defined in git-github/src/GithubAdapter.ts:388

fetchFileTree

fetchFileTree(branch?: string): Promise<FileTreeNode[]>
Parameters
- Optionalbranch: string
Returns Promise<FileTreeNode[]>
Overrides AbstractGitForgeAdapter.fetchFileTree
- Defined in git-github/src/GithubAdapter.ts:384

getCliInstallHint

getCliInstallHint(): string
Returns string
Overrides AbstractGitForgeAdapter.getCliInstallHint
- Defined in git-github/src/GithubAdapter.ts:55

getExecutionMode

getExecutionMode(): Promise<"cli" | "http">
Dynamically resolves execution mode: 'cli' if CLI tool exists and is accessible, otherwise 'http'

Returns Promise<"cli" | "http">
Inherited from AbstractGitForgeAdapter.getExecutionMode
- Defined in git/src/AbstractGitForgeAdapter.ts:37

isCliAvailable

isCliAvailable(): Promise<boolean>
Returns Promise<boolean>
Overrides AbstractGitForgeAdapter.isCliAvailable
- Defined in git-github/src/GithubAdapter.ts:46

passthrough

passthrough(args: string[]): Promise<number>
Parameters
- args: string[]
Returns Promise<number>
Overrides AbstractGitForgeAdapter.passthrough
- Defined in git-github/src/GithubAdapter.ts:441

prCheckout

prCheckout(prNumber: number): Promise<void>
Parameters
- prNumber: number
Returns Promise<void>
Overrides AbstractGitForgeAdapter.prCheckout
- Defined in git-github/src/GithubAdapter.ts:323

prCreate

prCreate(options: PrCreateOptions): Promise<PullRequest>
Parameters
- options: PrCreateOptions
Returns Promise<PullRequest>
Overrides AbstractGitForgeAdapter.prCreate
- Defined in git-github/src/GithubAdapter.ts:278

prList

prList(options?: PrListOptions): Promise<PullRequest[]>
Parameters
- Optionaloptions: PrListOptions
Returns Promise<PullRequest[]>
Overrides AbstractGitForgeAdapter.prList
- Defined in git-github/src/GithubAdapter.ts:194

prMerge

prMerge(prNumber: number, options?: PrMergeOptions): Promise<void>
Parameters
- prNumber: number
- Optionaloptions: PrMergeOptions
Returns Promise<void>
Overrides AbstractGitForgeAdapter.prMerge
- Defined in git-github/src/GithubAdapter.ts:332

prView

prView(prNumber: number): Promise<PullRequest>
Parameters
- prNumber: number
Returns Promise<PullRequest>
Overrides AbstractGitForgeAdapter.prView
- Defined in git-github/src/GithubAdapter.ts:236

pull

pull(branch?: string): Promise<void>
Parameters
- branch: string = "main"
Returns Promise<void>
Overrides AbstractGitForgeAdapter.pull
- Defined in git-github/src/GithubAdapter.ts:393

push

push(files: CommitFile[], message: string, branch?: string): Promise<void>
Parameters
- files: CommitFile[]
- message: string
- branch: string = "main"
Returns Promise<void>
Overrides AbstractGitForgeAdapter.push
- Defined in git-github/src/GithubAdapter.ts:402

redact

redact(text: string): string
Cybersecurity: Redact sensitive tokens from URLs and log messages
Parameters
- text: string
Returns string
Inherited from AbstractGitForgeAdapter.redact
- Defined in git/src/AbstractGitForgeAdapter.ts:107

releaseCreate

releaseCreate(options: ReleaseCreateOptions): Promise<void>
Parameters
- options: ReleaseCreateOptions
Returns Promise<void>
Overrides AbstractGitForgeAdapter.releaseCreate
- Defined in git-github/src/GithubAdapter.ts:356

repoClone

repoClone(target: string, destination?: string): Promise<void>
Parameters
- target: string
- Optionaldestination: string
Returns Promise<void>
Overrides AbstractGitForgeAdapter.repoClone
- Defined in git-github/src/GithubAdapter.ts:186

repoCreate

repoCreate(options: RepoCreateOptions): Promise<RepoDetails>
Parameters
- options: RepoCreateOptions
Returns Promise<RepoDetails>
Overrides AbstractGitForgeAdapter.repoCreate
- Defined in git-github/src/GithubAdapter.ts:163

repoView

repoView(): Promise<RepoDetails>
Returns Promise<RepoDetails>
Overrides AbstractGitForgeAdapter.repoView
- Defined in git-github/src/GithubAdapter.ts:119

`Protected`spawnSafe

spawnSafe(
    binary: string,
    args: string[],
    env?: Record<string, string>,
): Promise<{ exitCode: number; stderr: string; stdout: string }>
Cybersecurity: Safe process execution without shell interpolation (prevents shell injection)
Parameters
- binary: string
- args: string[]
- Optionalenv: Record<string, string>
Returns Promise<{ exitCode: number; stderr: string; stdout: string }>
Inherited from AbstractGitForgeAdapter.spawnSafe
- Defined in git/src/AbstractGitForgeAdapter.ts:67

whoami

whoami(): Promise<string>
Returns Promise<string>
Overrides AbstractGitForgeAdapter.whoami
- Defined in git-github/src/GithubAdapter.ts:113

Class GithubAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GithubAdapter

Properties

Readonlycontext

ReadonlyforgeType

Methods

authStatus

Returns Promise<AuthStatus>

createBranch

Parameters

Returns Promise<void>

downloadBlob

Parameters

Returns Promise<string>

fetchFileTree

Parameters

Returns Promise<FileTreeNode[]>

getCliInstallHint

Returns string

getExecutionMode

Returns Promise<"cli" | "http">

isCliAvailable

Returns Promise<boolean>

passthrough

Parameters

Returns Promise<number>

prCheckout

Parameters

Returns Promise<void>

prCreate

Parameters

Returns Promise<PullRequest>

prList

Parameters

Returns Promise<PullRequest[]>

prMerge

Parameters

Returns Promise<void>

prView

Parameters

Returns Promise<PullRequest>

pull

Parameters

Returns Promise<void>

push

Parameters

Returns Promise<void>

redact

Parameters

Returns string

releaseCreate

Parameters

Returns Promise<void>

repoClone

Parameters

Returns Promise<void>

repoCreate

Parameters

Returns Promise<RepoDetails>

repoView

Returns Promise<RepoDetails>

ProtectedspawnSafe

Parameters

Returns Promise<{ exitCode: number; stderr: string; stdout: string }>

whoami

Returns Promise<string>

Settings

On This Page

`Readonly`context

`Readonly`forgeType

`Protected`spawnSafe