@atomist/sdm/lib/api/goal/SdmGoalEvent.d.ts

Atomist Software Delivery Machine SDK

import { PushFields, SdmGoalState } from "../../typings/types";
import { SdmGoalKey, SdmProvenance } from "./SdmGoalMessage";
/**
 * An SdmGoal event.
 *
 * After https://github.com/atomisthq/automation-api/issues/479 is fixed,
 * and we make the required fields NonNull in GraphQL,
 * change this to be a type alias for SdmGoalFields.Fragment.
 */
export interface SdmGoalEvent extends SdmGoalKey {
    sha: string;
    branch: string;
    push: PushFields.Fragment;
    fulfillment: {
        method: string;
        registration: string;
        name: string;
    };
    repo: {
        owner: string;
        name: string;
        providerId: string;
    };
    /**
     * Current description that goes with the current status
     */
    description?: string;
    descriptions?: {
        canceled: string;
        completed: string;
        failed: string;
        inProcess: string;
        planned: string;
        requested: string;
        stopped: string;
        skipped: string;
        waitingForApproval: string;
        waitingForPreApproval: string;
    };
    url?: string;
    externalUrls?: Array<{
        label?: string;
        url: string;
    }>;
    goalSet: string;
    registration: string;
    goalSetId: string;
    state: SdmGoalState;
    phase?: string;
    /**
     * Timestamp
     */
    ts: number;
    error?: string;
    retryFeasible?: boolean;
    approval?: SdmProvenance;
    approvalRequired?: boolean;
    preApproval?: SdmProvenance;
    preApprovalRequired?: boolean;
    provenance: SdmProvenance[];
    preConditions: SdmGoalKey[];
    externalKey?: string;
    data?: string;
    version?: number;
}
//# sourceMappingURL=SdmGoalEvent.d.ts.map