API 参考 / @142vip/changelog / GithubAPI

const GithubAPI: object

Defined in: changelog/src/core/github.api.ts:219

createGithubRelease: (options) => Promise<void>

发送github发布

• https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28

string

string

boolean

string

boolean

string

string

string

Promise<void>

generateReleaseUrl: (markdown, config) => string

生成手动release发布的地址链接

string

string

string

boolean

string

string

string

getAuthorInfo: (options, info) => Promise<GitAuthorInfo>

string

string

string

GitAuthorInfo

Promise<GitAuthorInfo>

getHeaders: (token) => object

string

object

accept: string = 'application/vnd.github.v3+json'

authorization: string

isExistTag: (tag, options) => Promise<boolean>

判断是否有tag

string

string

string

string

Promise<boolean>

printReleaseUrl: (webUrl, success) => void

打印手动发布地址

• 默认成功输出

string

boolean = true

void

resolveAuthors: (commits, options) => Promise<GitAuthorInfo[]>

Commit[]

string

string

string

Promise<GitAuthorInfo[]>