@atomist/sdm/src/lib/spi/issue/IssueRouter.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 { ProjectOperationCredentials } from "@atomist/automation-client/lib/operations/common/ProjectOperationCredentials";
import { RemoteRepoRef } from "@atomist/automation-client/lib/operations/common/RepoId";
import { Issue } from "@atomist/automation-client/lib/util/gitHub";

/**
 * Implemented by types that can raise issues
 */
export interface IssueRouter {

    /**
     * Raise an issue with the given routing strategy.
     * @param {ProjectOperationCredentials} credentials
     * @param {RemoteRepoRef} id
     * @param {Issue} issue
     * @return {Promise<void>}
     */
    raiseIssue(credentials: ProjectOperationCredentials,
               id: RemoteRepoRef,
               issue: Issue): Promise<void>;
}