GitHubManager

Class Octokit을 사용하여 Github Api를 쉽게 사용할 수 있도록 하는 모듈입니다. 레포지토리 생성, 컨텐츠 업로드 등의 메서드가 있습니다. @see Octokit REST.js GitHub REST API Quickstart

Signature

declare class GitHubManager 

Constructors

Constructor	Modifiers	Description
(constructor)(data)		Constructs a new instance of the GitHubManager class

Properties

Property	Modifiers	Type	Description
addCollaborator		({ username, permission, owner, repo, ...params }: AddCollaboratorParams) => Promise<void>	레포지토리에 협력할 팀원(collaborator)을 추가하는 메소드입니다. @see GitHub API - Add a repository collaborator
checkAppAuthWithJWT		() => Promise<boolean>	GitHub App의 인증 자격 증명이 유효한지 확인하는 데 사용됩니다. JWT를 사용하여 이 엔드포인트에 접근해야 하며, GitHub App user access tokens, GitHub App installation access tokens, or fine-grained personal access tokens으로는 작동하지 않습니다. @see GitHub API - Get the authenticated app
checkAuthUser		() => Promise<boolean>	주어진 auth 토큰으로 사용자의 인증 상태를 확인합니다. 주어진 token에 대해 인증된 사용자인지 확인합니다. @see GitHub API - Get the authenticated app
checkOrganizationValidity		(org?: string) => Promise<boolean>	유효한 조직(Organization)인지 확인하는 메소드입니다. @see GitHub API - Get an organization
checkOwnerAccess		(owner: string) => Promise<boolean>	주입된 토큰이 주어진 owner에 대한 권한이 있는지 확인하는 메서드입니다.
commitToBranch		({ branchName, commitSha, owner, repo }: CommitToBranchParams) => Promise<void>	지정한 브랜치에 커밋을 하는 메소드입니다. @see GitHub API - Update a reference
createBlob		({ content, owner, repo }: CreateBlobParams) => Promise<BlobFileData>	파일에 대한 blob를 생성하는 메소드입니다. @see GitHub API - Create a blob
createBranch		({ branchName, baseBranchName, owner, repo }: CreateBranchParams) => Promise<void>	새 브랜치를 생성하는 메소드입니다. @see GitHub API - Create a reference
createNewCommit		({ branchName, contents, paths, message, owner, repo }: CreateNewCommitParams) => Promise<any>	주어진 파일 경로와 내용을 기반으로 새로운 커밋을 생성합니다.
createRepo		({ isPrivate, owner, repo }: CreateRepoParams) => Promise<RestEndpointMethodTypes["repos"]["createInOrg"]["response"]["data"] & { isOrg: boolean; }>	새로운 레포지토리를 생성하는 메소드입니다. @see GitHub API - Create an organization repository @see GitHub API - Create a repository for the authenticated user
getCurrentCommit		({ branchName, owner, repo }: GetCurrentCommitParams) => Promise<{ commitSha: string; treeSha: string; }>	현재 커밋을 가져오는 메소드입니다. @see GitHub API - Get a commit object
getUser		() => Promise<RestEndpointMethodTypes["users"]["getAuthenticated"]["response"]["data"]>	인증된 유지의 정보를 조회하는 메소드입니다. @see GitHub API - Get the authenticated app
isBranchExist		({ branchName, owner, repo }: IsBranchExistParams) => Promise<boolean>	브랜치가 존재하는지 확인하는 메소드입니다. @see GitHub API - Get a branch
isRepoExist		(owner?: string, repo?: string) => Promise<boolean>	레포지토리가 존재하는지 확인하는 메소드입니다. @see @see GitHub API - Get a repository
publishFilesToNewRepo		({ contents, paths, isPrivate, message, branchName, owner, repo }: PublishFilesToNewRepoParams) => Promise<void>	새로운 레포지토리에 주어진 내용을 게시하는 메소드입니다.
removeCollaborator		({ username, owner, repo }: RemoveCollaboratorParams) => Promise<void>	레포지토리에 팀원를 제거하는 메소드입니다. @see GitHub API - Remove a repository collaborator
updateExistRepo		({ contents, paths, message, branchName, baseBranchName, owner, repo }: UpdateExistRepoParams) => Promise<void>	기존 레포지토리에 지정된 브랜치로 주어진 내용을 업로드(push)해주는 메소드입니다.