API 参考
    正在准备搜索索引...

    类 GithubAPI

    GitHub REST 与 Release 相关 API

    索引
    constructor
    buildGithubReleaseRequestBody createGithubRelease fetchGitHubJson generateReleaseUrl getAuthorInfo getHeaders isExistTag printReleaseUrl resolveAuthors
    buildGithubReleaseRequestBody: (
        options: {
            content: string;
            draft?: boolean;
            includeMakeLatest?: boolean;
            name: string;
            prerelease?: boolean;
            tag: string;
        },
    ) => Record<string, unknown> = buildGithubReleaseRequestBody

    类型声明

      • (
            options: {
                content: string;
                draft?: boolean;
                includeMakeLatest?: boolean;
                name: string;
                prerelease?: boolean;
                tag: string;
            },
        ): Record<string, unknown>

      • 构建 GitHub Release API 请求体

        • 非预发布时附带 make_latest: true

        参数

        • options: {
              content: string;
              draft?: boolean;
              includeMakeLatest?: boolean;
              name: string;
              prerelease?: boolean;
              tag: string;
          }
          • content: string
          • 可选draft?: boolean
          • 可选includeMakeLatest?: boolean

            仅 POST 新建 Release 时可传 make_latest；PATCH 携带会触发 422

          • name: string
          • 可选prerelease?: boolean
          • tag: string

        返回 Record<string, unknown>

    createGithubRelease: (
        options: {
            baseUrlApi: string;
            content: string;
            draft?: boolean;
            name: string;
            prerelease?: boolean;
            repo: string;
            tag: string;
            token: string;
        },
    ) => Promise<void> = createGithubRelease

    类型声明

      • (
            options: {
                baseUrlApi: string;
                content: string;
                draft?: boolean;
                name: string;
                prerelease?: boolean;
                repo: string;
                tag: string;
                token: string;
            },
        ): Promise<void>

      • 创建或更新 GitHub Release

        参数

        • options: {
              baseUrlApi: string;
              content: string;
              draft?: boolean;
              name: string;
              prerelease?: boolean;
              repo: string;
              tag: string;
              token: string;
          }

        返回 Promise<void>

    fetchGitHubJson: <T>(
        url: string,
        init?: { body?: Record<string, unknown>; method?: string; token?: string },
    ) => Promise<T> = fetchGitHubJson

    类型声明

      • <T>(
            url: string,
            init?: { body?: Record<string, unknown>; method?: string; token?: string },
        ): Promise<T>

      • GitHub REST 请求（Node 18+ 原生 fetch）

        类型参数

        • T

        参数

        • url: string
        • init: { body?: Record<string, unknown>; method?: string; token?: string } = {}

        返回 Promise<T>

    generateReleaseUrl: (
        markdown: string,
        config: {
            baseUrl: string;
            name: string;
            prerelease: boolean;
            repo: string;
            to: string;
        },
    ) => string = generateReleaseUrl

    类型声明

      • (
            markdown: string,
            config: {
                baseUrl: string;
                name: string;
                prerelease: boolean;
                repo: string;
                to: string;
            },
        ): string

      • 生成 GitHub Web「新建 Release」链接（token 缺失时手动发布）

        参数

        • markdown: string
        • config: { baseUrl: string; name: string; prerelease: boolean; repo: string; to: string }

        返回 string

    getAuthorInfo: (
        options: { baseUrlApi: string; repo: string; token: string },
        info: GitAuthorInfo,
    ) => Promise<GitAuthorInfo> = getAuthorInfo
    getHeaders: (token: string) => { accept: string; authorization: string } = getHeaders
    isExistTag: (
        tag: string,
        options: { baseUrlApi: string; repo: string; token: string },
    ) => Promise<boolean> = isExistTag

    类型声明

      • (
            tag: string,
            options: { baseUrlApi: string; repo: string; token: string },
        ): Promise<boolean>

      • 检查远程 tag 是否存在

        参数

        • tag: string
        • options: { baseUrlApi: string; repo: string; token: string }

        返回 Promise<boolean>

    printReleaseUrl: (webUrl: string, success?: boolean) => void = printReleaseUrl
    resolveAuthors: (
        commits: Commit[],
        options: { baseUrlApi: string; repo: string; token?: string },
    ) => Promise<GitAuthorInfo[]> = resolveAuthors

    类型声明

      • (
            commits: Commit[],
            options: { baseUrlApi: string; repo: string; token?: string },
        ): Promise<GitAuthorInfo[]>

      • 为 commit 列表解析 GitHub 贡献者 login

        参数

        • commits: Commit[]
        • options: { baseUrlApi: string; repo: string; token?: string }

        返回 Promise<GitAuthorInfo[]>

    显示设置
    成员可见性

    目录
    构造函数
    属性