deliverybot/lib/deploy.d.ts

Controls and configures deployments using the GitHub API.

import Octokit from "@octokit/rest";
import { LockStore } from "./store";
import { Logger } from "probot";
import { PullsGetResponse } from "@octokit/rest";
import { Targets } from "./types";
export declare function config(github: Octokit, { owner, repo, ref }: {
    owner: string;
    repo: string;
    ref?: string;
}): Promise<Targets>;
/**
 * Deploy commit handles all the necessities of creating a conformant deployment
 * including templating and more. All deploys should go through this function.
 * We need to deploy always using the ref of a branch so that finding
 * deployments later we can query using the branch ref.
 *
 * Throws ConfigError, LockError.
 */
export declare function deploy(github: Octokit, log: Logger, kv: LockStore, { owner, repo, target, ref, sha, pr }: {
    owner: string;
    repo: string;
    target: string;
    ref: string;
    sha: string;
    pr?: PullsGetResponse;
}): Promise<Octokit.ReposCreateDeploymentResponse>;