Interface GitServiceInterface

Provide methods that must be implement by GithubService and GitlabService to interact with git repository

Hierarchy

GitServiceInterface

Implemented by

Index

Methods

Methods

addIssueComment

addIssueComment(gitIssueInfos: GitIssueInfos): void

- Defined in git/git.service.interface.ts:33
Add a comment to a specific issue according to the gitIssueInfos param

Parameters
- gitIssueInfos: GitIssueInfos
Returns void

addPRComment

addPRComment(gitCommentPRInfos: GitCommentPRInfos): void

- Defined in git/git.service.interface.ts:39
Add a comment to a specific Pull Request / Merge Request according to the gitCommentPRInfos param

Parameters
- gitCommentPRInfos: GitCommentPRInfos
Returns void

createIssue

createIssue(gitIssueInfos: GitIssueInfos): Promise<number>

- Defined in git/git.service.interface.ts:54
Create an Issue whose attributes are specify by the gitCommitStatusInfos param

Parameters
- gitIssueInfos: GitIssueInfos
Returns Promise<number>

createPullRequest

createPullRequest(gitCreatePRInfos: GitPRInfos): void

- Defined in git/git.service.interface.ts:44
Create a Pull Request / Merge Request whose attributes are specify by the gitCreatePRInfos param

Parameters
- gitCreatePRInfos: GitPRInfos
Returns void

createRelease

createRelease(gitRelease: GitRelease): void

- Defined in git/git.service.interface.ts:100
Parameters
- gitRelease: GitRelease
Returns void

createWebhook

createWebhook(webhookURL: string): void

- Defined in git/git.service.interface.ts:88
Add a Webhook to the repository listening all events

Parameters
- webhookURL: string
Returns void

deleteBranch

deleteBranch(branchName: string): void

- Defined in git/git.service.interface.ts:49
Delete the brachName branch

Parameters
- branchName: string
Returns void

deleteFile

deleteFile(gitFileInfos: GitFileInfos): Promise<void>

- Defined in git/git.service.interface.ts:73
Remove a particular file describe in gitFileInfos

Parameters
- gitFileInfos: GitFileInfos
Returns Promise<void>

getFileContent

getFileContent(gitFileInfos: GitFileInfos): Promise<GitFileData>

- Defined in git/git.service.interface.ts:104
Parameters
- gitFileInfos: GitFileInfos
Returns Promise<GitFileData>

getIssues

getIssues(gitIssueSearch: GitIssuePRSearch): Promise<IssueSearchResult[]>

- Defined in git/git.service.interface.ts:93
Get Issues with custom filters

Parameters
- gitIssueSearch: GitIssuePRSearch
Returns Promise<IssueSearchResult[]>

getLastBranchesCommitSha

getLastBranchesCommitSha(): Promise<GitBranchCommit[]>

- Defined in git/git.service.interface.ts:102
Returns Promise<GitBranchCommit[]>

getPullRequests

getPullRequests(gitIssueSearch: GitIssuePRSearch): Promise<PRSearchResult[]>

- Defined in git/git.service.interface.ts:98
Get Pull Requests with custom filters

Parameters
- gitIssueSearch: GitIssuePRSearch
Returns Promise<PRSearchResult[]>

mergePullRequest

mergePullRequest(gitMergePRInfos: GitMergePRInfos): void

- Defined in git/git.service.interface.ts:78
Merge a Pull Request specify in gitMergePRInfos

Parameters
- gitMergePRInfos: GitMergePRInfos
Returns void

setEnvironmentVariables

setEnvironmentVariables(dataAccessService: DataAccessService, filePath: string): Promise<void>

- Defined in git/git.service.interface.ts:65
Initialize gitApi and gitToken env. variables on new webhook by reading the corresponding config.env file

Parameters
- dataAccessService: DataAccessService
- filePath: string
Returns Promise<void>

updateCommitStatus

updateCommitStatus(gitCommitStatusInfos: GitCommitStatusInfos): void

- Defined in git/git.service.interface.ts:27
Update a specific commit's status according to the gitCommitStatusInfos param

Parameters
- gitCommitStatusInfos: GitCommitStatusInfos
Returns void

updateIssue

updateIssue(gitIssueInfos: GitIssueInfos): void

- Defined in git/git.service.interface.ts:59
Update an issue partially

Parameters
- gitIssueInfos: GitIssueInfos
Returns void

updatePullRequest

updatePullRequest(gitPRInfos: GitPRInfos): void

- Defined in git/git.service.interface.ts:83
Update a Pull Request partially

Parameters
- gitPRInfos: GitPRInfos
Returns void

Generated using TypeDoc