Class GithubPlatformService

GitHub platform service implementation

Hierarchy (View Summary)

GitPlatformService
- GithubPlatformService

Index

Constructors

Methods

createMergeRequest createMergeRequestLegacy getBaseUrl getPlatformName getProject getProjectByPath

Constructors

constructor

new GithubPlatformService(
    token: string,
    baseUrl: string,
    gitService: GitService,
    http: HttpClient,
): GithubPlatformService
Parameters
- token: string
- baseUrl: string
- gitService: GitService
- http: HttpClient
Returns GithubPlatformService
Overrides GitPlatformService.constructor
- Defined in services/github-platform-service.ts:30

Methods

createMergeRequest

createMergeRequest(
    sourceBranch: string,
    targetBranch: string,
    title: string,
    options?: MergeRequestOptions,
): Promise<string>
Create a merge/pull request
Parameters
- sourceBranch: string
  Source branch name
- targetBranch: string
  Target branch name
- title: string
  Request title
- Optionaloptions: MergeRequestOptions
  Merge request options including assignees, reviewers, squash, etc.
Returns Promise<string>
Web URL of the created request
Inherited from GitPlatformService.createMergeRequest
- Defined in services/git-platform-service.ts:116

createMergeRequestLegacy

createMergeRequestLegacy(
    sourceBranch: string,
    targetBranch: string,
    title: string,
    squash?: boolean,
    removeSourceBranch?: boolean,
): Promise<string>
Create a merge/pull request (legacy method for backward compatibility)
Parameters
- sourceBranch: string
  Source branch name
- targetBranch: string
  Target branch name
- title: string
  Request title
- Optionalsquash: boolean
  Whether to squash commits
- OptionalremoveSourceBranch: boolean
  Whether to remove source branch after merge
Returns Promise<string>
Web URL of the created request

Deprecated
Use createMergeRequest with options parameter instead
Inherited from GitPlatformService.createMergeRequestLegacy
- Defined in services/git-platform-service.ts:136

getBaseUrl

getBaseUrl(): string
Get the base URL of this service

Returns string
Inherited from GitPlatformService.getBaseUrl
- Defined in services/git-platform-service.ts:153

getPlatformName

getPlatformName(): string
Get the platform name (e.g., 'gitlab', 'github')

Returns string
Overrides GitPlatformService.getPlatformName
- Defined in services/github-platform-service.ts:34

getProject

getProject(): Promise<GitPlatformProject>
Get project information from current Git remote

Returns Promise<GitPlatformProject>
Project information
Inherited from GitPlatformService.getProject
- Defined in services/git-platform-service.ts:75

getProjectByPath

getProjectByPath(projectPath: string): Promise<GitPlatformProject>
Get project information by path
Parameters
- projectPath: string
  Project path (e.g., 'user/repo')
Returns Promise<GitPlatformProject>
Project information
Overrides GitPlatformService.getProjectByPath
- Defined in services/github-platform-service.ts:38