@atomist/sdm/src/lib/api/goal/tagGoalSet.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 { PushListenerInvocation } from "../listener/PushListener";
import { SdmGoalMessage } from "./SdmGoalMessage";

export interface GoalSetTag {
    name: string;
    value?: string;
}

/**
 * Create Tags for the goal set containing the provided goals
 */
export type TagGoalSet = (goals: SdmGoalMessage[], pli: PushListenerInvocation) => Promise<GoalSetTag[] | undefined>;