@atomist/cortex/Build.ts

Atomist Cortex model TypeScript typings

/*
 * Copyright 2015-2017 Atomist Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { TreeNode, GraphNode, FormatInfo, PathExpressionEngine } from "@atomist/rug/tree/PathExpression";
import { ProjectContext } from "@atomist/rug/operations/ProjectEditor";
import { Commit } from "./Commit";
import { PullRequest } from "./PullRequest";
import { Push } from "./Push";
import { Repo } from "./Repo";
import { SpinnakerPipeline } from "./SpinnakerPipeline";
export { Build };

/**
 * Type Build
 */
interface Build extends GraphNode {

    /**
     * buildUrl
     *
     * @property {string} buildUrl
     */
    readonly buildUrl: string;

    /**
     * commit - Build -> Commit
     *
     * @property {Commit} commit
     */
    readonly commit: Commit;

    /**
     * compareUrl
     *
     * @property {string} compareUrl
     */
    readonly compareUrl: string;

    /**
     * finishedAt
     *
     * @property {string} finishedAt
     */
    readonly finishedAt: string;

    /**
     * id
     *
     * @property {string} id
     */
    readonly id: string;

    /**
     * name
     *
     * @property {string} name
     */
    readonly name: string;

    /**
     * provider
     *
     * @property {string} provider
     */
    readonly provider: string;

    /**
     * pullRequest - Build -> PullRequest
     *
     * @property {PullRequest} pullRequest
     */
    readonly pullRequest: PullRequest;

    /**
     * pullRequestNumber
     *
     * @property {number} pullRequestNumber
     */
    readonly pullRequestNumber: number;

    /**
     * push - Build -> Push
     *
     * @property {Push} push
     */
    readonly push: Push;

    /**
     * repo - Build -> Repo
     *
     * @property {Repo} repo
     */
    readonly repo: Repo;

    /**
     * spinnakerPipeline - Build -> SpinnakerPipeline
     *
     * @property {SpinnakerPipeline} spinnakerPipeline
     */
    readonly spinnakerPipeline: SpinnakerPipeline;

    /**
     * startedAt
     *
     * @property {string} startedAt
     */
    readonly startedAt: string;

    /**
     * status
     *
     * @property {"passed" | "broken" | "failed" | "started" | "canceled"} status
     */
    readonly status: "passed" | "broken" | "failed" | "started" | "canceled";

    /**
     * timestamp
     *
     * @property {string} timestamp
     */
    readonly timestamp: string;

    /**
     * trigger
     *
     * @property {"pull_request" | "push"} trigger
     */
    readonly trigger: "pull_request" | "push";

}