@atomist/sdm/src/lib/api/goal/SdmGoalSetMessage.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2019 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 { SdmGoalState } from "../../typings/types";
import { SdmProvenance } from "./SdmGoalMessage";
import { GoalSetTag } from "./tagGoalSet";

/**
 * Data persisted in the Atomist Cortex
 */
export interface SdmGoalSetMessage {
    sha: string;
    branch: string;

    repo: {
        name: string;
        owner: string;
        providerId: string;
    };

    state: SdmGoalState;

    goalSet: string;
    goalSetId: string;
    ts: number;

    goals: Array<{ name: string, uniqueName: string }>;

    provenance: SdmProvenance;

    tags?: GoalSetTag[];
}