Class GithubAdapter

Repository integration logic specifically adapting GitHub via the official Octokit SDK.

Hierarchy (View Summary)

AbstractRepositoryAdapter
- GithubAdapter

Index

Constructors

Properties

_octokit _owner _repo

Methods

createBranch pull push

Constructors

constructor

new GithubAdapter(auth: string, owner: string, repo: string): GithubAdapter
Parameters
- auth: string
- owner: string
- repo: string
Returns GithubAdapter
Overrides AbstractRepositoryAdapter.constructor
- Defined in packages/code-github/src/GithubAdapter.ts:12

Properties

`Protected`_octokit

_octokit: Octokit & { paginate: PaginateInterface } & RestEndpointMethods & Api

`Protected`_owner

_owner: string

`Protected`_repo

_repo: string

Methods

createBranch

createBranch(branchName: string, fromBranch?: string): Promise<void>
Creates a new branch via the GitHub API based on an existing branch's latest commit.
Parameters
- branchName: string
  The new branch name.
- fromBranch: string = 'main'
  The source branch name.
Returns Promise<void>
Overrides AbstractRepositoryAdapter.createBranch
- Defined in packages/code-github/src/GithubAdapter.ts:108

pull

pull(branch?: string): Promise<void>
Fetches the latest reference for a specific branch from GitHub.
Parameters
- branch: string = 'main'
  The branch name to pull.
Returns Promise<void>
Overrides AbstractRepositoryAdapter.pull
- Defined in packages/code-github/src/GithubAdapter.ts:24

push

push(files: CommitFile[], message: string, branch?: string): Promise<void>
Commits and pushes a set of files to a specified GitHub branch.
Parameters
- files: CommitFile[]
  List of files to commit.
- message: string
  The commit message.
- branch: string = 'main'
  The target branch name.
Returns Promise<void>
Overrides AbstractRepositoryAdapter.push
- Defined in packages/code-github/src/GithubAdapter.ts:40