release-please 17.4.1 → 17.5.0

package/build/src/github.d.ts

@@ -2,18 +2,15 @@ import { PullRequest } from './pull-request';
 import { Commit } from './commit';
 import { Octokit } from '@octokit/rest';
 import { request } from '@octokit/request';
-export declare const GH_API_URL = "https://api.github.com";
-export declare const GH_GRAPHQL_URL = "https://api.github.com";
 type OctokitType = InstanceType<typeof Octokit>;
 import { Repository } from './repository';
 import { ReleasePullRequest } from './release-pull-request';
 import { Update } from './update';
 import { Release } from './release';
+import { GitHubApi, GitHubCreateOptions } from './github-api';
 import { GitHubFileContents } from '@google-automations/git-file-utils';
 import { Logger } from 'code-suggester/build/src/types';
-import { HttpsProxyAgent } from 'https-proxy-agent';
-import { HttpProxyAgent } from 'http-proxy-agent';
-import { PullRequestOverflowHandler } from './util/pull-request-overflow-handler';
+import { Scm, ScmChangeSet, ScmCommitIteratorOptions, ScmReleaseIteratorOptions, ScmTagIteratorOptions, ScmCreatePullRequestOptions, ScmReleaseOptions, ScmRelease, ScmTag, ScmUpdatePullRequestOptions } from './scm';
 type RequestBuilderType = typeof request;
 type DefaultFunctionType = RequestBuilderType['defaults'];
 type RequestFunctionType = ReturnType<DefaultFunctionType>;
@@ -27,96 +24,25 @@ export interface GitHubOptions {
     octokitAPIs: OctokitAPIs;
     logger?: Logger;
 }
-interface ProxyOption {
-    host: string;
-    port: number;
-}
-interface GitHubCreateOptions {
-    owner: string;
-    repo: string;
-    defaultBranch?: string;
-    apiUrl?: string;
-    graphqlUrl?: string;
-    octokitAPIs?: OctokitAPIs;
-    token?: string;
-    logger?: Logger;
-    proxy?: ProxyOption;
-    fetch?: any;
-}
 type CommitFilter = (commit: Commit) => boolean;
-interface CommitIteratorOptions {
-    maxResults?: number;
-    backfillFiles?: boolean;
-    batchSize?: number;
-}
-interface ReleaseIteratorOptions {
-    maxResults?: number;
-}
-interface TagIteratorOptions {
-    maxResults?: number;
-}
-export interface ReleaseOptions {
-    draft?: boolean;
-    prerelease?: boolean;
-    forceTag?: boolean;
-}
-export interface GitHubRelease {
-    id: number;
-    name?: string;
-    tagName: string;
-    sha: string;
-    notes?: string;
-    url: string;
-    draft?: boolean;
-    uploadUrl?: string;
-}
-export interface GitHubTag {
-    name: string;
-    sha: string;
-}
-interface FileDiff {
-    readonly mode: '100644' | '100755' | '040000' | '160000' | '120000';
-    readonly content: string | null;
-    readonly originalContent: string | null;
-}
-export type ChangeSet = Map<string, FileDiff>;
-interface CreatePullRequestOptions {
-    fork?: boolean;
-    draft?: boolean;
-}
-export declare class GitHub {
+type CommitIteratorOptions = ScmCommitIteratorOptions;
+type ReleaseIteratorOptions = ScmReleaseIteratorOptions;
+type TagIteratorOptions = ScmTagIteratorOptions;
+export type ReleaseOptions = ScmReleaseOptions;
+export type GitHubRelease = ScmRelease;
+export type GitHubTag = ScmTag;
+export type ChangeSet = ScmChangeSet;
+type CreatePullRequestOptions = ScmCreatePullRequestOptions;
+export declare class GitHub implements Scm {
     readonly repository: Repository;
     private octokit;
-    private request;
     private graphql;
     private fileCache;
     private logger;
+    private gitHubApi;
     private constructor();
-    static createDefaultAgent(baseUrl: string, defaultProxy?: ProxyOption): HttpProxyAgent<`http://${string}:${number}`> | HttpsProxyAgent<`https://${string}:${number}`> | undefined;
-    /**
-     * Build a new GitHub client with auto-detected default branch.
-     *
-     * @param {GitHubCreateOptions} options Configuration options
-     * @param {string} options.owner The repository owner.
-     * @param {string} options.repo The repository name.
-     * @param {string} options.defaultBranch Optional. The repository's default branch.
-     *   Defaults to the value fetched via the API.
-     * @param {string} options.apiUrl Optional. The base url of the GitHub API.
-     * @param {string} options.graphqlUrl Optional. The base url of the GraphQL API.
-     * @param {OctokitAPISs} options.octokitAPIs Optional. Override the internal
-     *   client instances with a pre-authenticated instance.
-     * @param {string} token Optional. A GitHub API token used for authentication.
-     */
+    getGitHubApi(): GitHubApi;
     static create(options: GitHubCreateOptions): Promise<GitHub>;
-    /**
-     * Returns the default branch for a given repository.
-     *
-     * @param {string} owner The GitHub repository owner
-     * @param {string} repo The GitHub repository name
-     * @param {OctokitType} octokit An authenticated octokit instance
-     * @returns {string} Name of the default branch
-     */
-    static defaultBranch(owner: string, repo: string, octokit: OctokitType): Promise<string>;
     /**
      * Returns the list of commits to the default branch after the provided filter
      * query has been satified.
@@ -169,36 +95,6 @@ export declare class GitHub {
      * @throws {GitHubAPIError} on an API error
      */
     pullRequestIterator(targetBranch: string, status?: 'OPEN' | 'CLOSED' | 'MERGED', maxResults?: number, includeFiles?: boolean): AsyncGenerator<PullRequest, void, void>;
-    /**
-     * Helper implementation of pullRequestIterator that includes files via
-     * the graphQL API.
-     *
-     * @param {string} targetBranch The base branch of the pull request
-     * @param {string} status The status of the pull request
-     * @param {number} maxResults Limit the number of results searched
-     */
-    private pullRequestIteratorWithFiles;
-    /**
-     * Helper implementation of pullRequestIterator that excludes files
-     * via the REST API.
-     *
-     * @param {string} targetBranch The base branch of the pull request
-     * @param {string} status The status of the pull request
-     * @param {number} maxResults Limit the number of results searched
-     */
-    private pullRequestIteratorWithoutFiles;
-    /**
-     * Return a list of merged pull requests. The list is not guaranteed to be sorted
-     * by merged_at, but is generally most recent first.
-     *
-     * @param {string} targetBranch - Base branch of the pull request. Defaults to
-     *   the configured default branch.
-     * @param {number} page - Page of results. Defaults to 1.
-     * @param {number} perPage - Number of results per page. Defaults to 100.
-     * @returns {PullRequestHistory | null} - List of merged pull requests
-     * @throws {GitHubAPIError} on an API error
-     */
-    private pullRequestsGraphQL;
     /**
      * Iterate through releases with a max number of results scanned.
      *
@@ -208,8 +104,7 @@ export declare class GitHub {
      * @yields {GitHubRelease}
      * @throws {GitHubAPIError} on an API error
      */
-    releaseIterator(options?: ReleaseIteratorOptions): AsyncGenerator<GitHubRelease, void, unknown>;
-    private releaseGraphQL;
+    releaseIterator(options?: ReleaseIteratorOptions): AsyncGenerator<ScmRelease, void, unknown>;
     /**
      * Iterate through tags with a max number of results scanned.
      *
@@ -290,21 +185,6 @@ export declare class GitHub {
      * @throws {GitHubAPIError} on an API error
      */
     findFilesByGlobAndRef: (glob: string, ref: string, prefix?: string | undefined) => Promise<string[]>;
-    /**
-     * Open a pull request
-     *
-     * @deprecated This logic is handled by the Manifest class now as it
-     *   can be more complicated if the release notes are too big
-     * @param {ReleasePullRequest} releasePullRequest Pull request data to update
-     * @param {string} targetBranch The base branch of the pull request
-     * @param {GitHubPR} options The pull request options
-     * @throws {GitHubAPIError} on an API error
-     */
-    createReleasePullRequest(releasePullRequest: ReleasePullRequest, targetBranch: string, options?: {
-        signoffUser?: string;
-        fork?: boolean;
-        skipLabeling?: boolean;
-    }): Promise<PullRequest>;
     /**
      * Open a pull request
      *
@@ -315,13 +195,13 @@ export declare class GitHub {
      * @param {CreatePullRequestOptions} options The pull request options
      * @throws {GitHubAPIError} on an API error
      */
-    createPullRequest: (pullRequest: PullRequest, targetBranch: string, message: string, updates: Update[], options?: CreatePullRequestOptions | undefined) => Promise<PullRequest>;
+    createPullRequest(pullRequest: PullRequest, targetBranch: string, message: string, updates: Update[], options?: CreatePullRequestOptions): Promise<PullRequest>;
     /**
      * Fetch a pull request given the pull number
      * @param {number} number The pull request number
      * @returns {PullRequest}
      */
-    getPullRequest: (number: number) => Promise<PullRequest>;
+    getPullRequest(number: number): Promise<PullRequest>;
     /**
      * Update a pull request's title and body.
      * @param {number} number The pull request number
@@ -333,11 +213,7 @@ export declare class GitHub {
      * @param {PullRequestOverflowHandler} options.pullRequestOverflowHandler Optional.
      *   Handles extra large pull request body messages.
      */
-    updatePullRequest: (number: number, releasePullRequest: ReleasePullRequest, targetBranch: string, options?: {
-        signoffUser?: string | undefined;
-        fork?: boolean | undefined;
-        pullRequestOverflowHandler?: PullRequestOverflowHandler | undefined;
-    } | undefined) => Promise<PullRequest>;
+    updatePullRequest(number: number, releasePullRequest: ReleasePullRequest, targetBranch: string, options?: ScmUpdatePullRequestOptions): Promise<PullRequest>;
     /**
      * Given a set of proposed updates, build a changeset to suggest.
      *
@@ -384,7 +260,7 @@ export declare class GitHub {
      * @throws {DuplicateReleaseError} if the release tag already exists
      * @throws {GitHubAPIError} on other API errors
      */
-    createRelease: (release: Release, options?: ReleaseOptions | undefined) => Promise<GitHubRelease>;
+    createRelease(release: Release, options?: ReleaseOptions): Promise<GitHubRelease>;
     /**
      * Makes a comment on a issue/pull request.
      *
@@ -392,21 +268,21 @@ export declare class GitHub {
      * @param {number} number - The issue or pull request number.
      * @throws {GitHubAPIError} on an API error
      */
-    commentOnIssue: (comment: string, number: number) => Promise<string>;
+    commentOnIssue(comment: string, number: number): Promise<string>;
     /**
      * Removes labels from an issue/pull request.
      *
      * @param {string[]} labels The labels to remove.
      * @param {number} number The issue/pull request number.
      */
-    removeIssueLabels: (labels: string[], number: number) => Promise<void>;
+    removeIssueLabels(labels: string[], number: number): Promise<void>;
     /**
      * Adds label to an issue/pull request.
      *
      * @param {string[]} labels The labels to add.
      * @param {number} number The issue/pull request number.
      */
-    addIssueLabels: (labels: string[], number: number) => Promise<void>;
+    addIssueLabels(labels: string[], number: number): Promise<void>;
     /**
      * Generate release notes from GitHub at tag
      * @param {string} tagName Name of new release tag
@@ -425,32 +301,6 @@ export declare class GitHub {
      * @returns {string} HTML URL of the new file
      */
     createFileOnNewBranch(filename: string, contents: string, newBranchName: string, baseBranchName: string): Promise<string>;
-    /**
-     * Helper to fetch the SHA of a branch
-     * @param {string} branchName The name of the branch
-     * @return {string | undefined} Returns the SHA of the branch
-     *   or undefined if it can't be found.
-     */
-    private getBranchSha;
-    /**
-     * Helper to fork a branch from an existing branch. Uses `force` so
-     * it will overwrite the contents of `targetBranchName` to match
-     * the current contents of `baseBranchName`.
-     *
-     * @param {string} targetBranchName The name of the new forked branch
-     * @param {string} baseBranchName The base branch from which to fork.
-     * @returns {string} The branch SHA
-     * @throws {ConfigurationError} if the base branch cannot be found.
-     */
-    private forkBranch;
-    /**
-     * Helper to create a new branch from a given SHA.
-     * @param {string} branchName The new branch name
-     * @param {string} branchSha The SHA of the branch
-     * @returns {string} The SHA of the new branch
-     */
-    private createNewBranch;
-    private updateBranchSha;
 }
 export declare const sleepInMs: (ms: number) => Promise<unknown>;
 export {};