@atomist/sdm/src/lib/pack/version/github.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2020 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 { GitHubRepoRef, isGitHubRepoRef } from "@atomist/automation-client/lib/operations/common/GitHubRepoRef";
import { isTokenCredentials } from "@atomist/automation-client/lib/operations/common/ProjectOperationCredentials";
import { logger } from "@atomist/automation-client/lib/util/logger";
import { LogSuppressor } from "../../api-helper/log/logInterpreters";
import { DefaultGoalNameGenerator } from "../../api/goal/GoalNameGenerator";
import { PushTest } from "../../api/mapping/PushTest";
import { createRelease } from "./octokit";
import { ReleaseCreator, ReleaseRegistration } from "./release";

/**
 * Create a GitHub release for GitHub.com or GHE projects.  If the
 * project is not a GitHub project or the project credentials do not
 * have a token, it issues are warning and returns success.
 */
export const GitHubReleaseCreator: ReleaseCreator = async args => {
    const slug = `${args.id.owner}/${args.id.repo}`;
    if (!isGitHubRepoRef(args.id)) {
        const message = `Project ${slug} is neither a GitHub.com nor GHE remote repository`;
        logger.warn(message);
        args.log.write(message);
        return { code: 0, message };
    }
    if (!isTokenCredentials(args.credentials)) {
        const message = `Project ${slug} credentials are not TokenCredentials`;
        logger.warn(message);
        args.log.write(message);
        return { code: 0, message };
    }

    try {
        let changelog: string | undefined;
        for (const ch of ["CHANGELOG.md", "CHANGELOG", "ChangeLog", "Changelog", "changelog"]) {
            if (await args.project.hasFile(ch)) {
                changelog = ch;
                break;
            }
        }
        await createRelease({
            auth: args.credentials.token,
            baseUrl: args.id.scheme + args.id.apiBase,
            owner: args.id.owner,
            repo: args.id.repo,
            version: args.releaseVersion,
            sha: args.goalEvent.sha,
            changelog,
        });
        const message = `Created GitHub release ${args.releaseVersion} for ${slug}`;
        args.log.write(message);
        const externalUrls = [{ label: args.releaseVersion, url: releaseUrl(args.id, args.releaseVersion) }];
        return { code: 0, message, externalUrls };
    } catch (e) {
        const message = `Failed to create GitHub release ${args.releaseVersion} for project ${slug}: ${e.message}`;
        logger.warn(message);
        args.log.write(message);
        return { code: 1, message };
    }
};

/**
 * Push test that returns true if the push was to a GitHub.com or GHE
 * remote repository.
 */
export const GitHubPushTest: PushTest = {
    name: "GitHubPushTest",
    mapping: async pli => isGitHubRepoRef(pli.id),
};

/**
 * Release registration for GitHub release creator implementation.
 */
export const GitHubReleaseRegistration: ReleaseRegistration = {
    logInterpreter: LogSuppressor,
    name: DefaultGoalNameGenerator.generateName("github-release"),
    pushTest: GitHubPushTest,
    releaseCreator: GitHubReleaseCreator,
};

function releaseUrl(id: GitHubRepoRef, version: string): string {
    return `${id.scheme}${id.remoteBase}/${id.owner}/${id.repo}/releases/tag/${version}`;
}