backport/dist/src/lib/cherrypickAndCreateTargetPullRequest/get-commits-without-backports.js

A CLI tool that automates the process of backporting commits

import chalk from 'chalk';
import { getIsCommitInBranch } from '../git/index.js';
import { getFirstLine } from '../github/commit-formatters.js';
import { fetchCommitsByAuthor } from '../github/v4/fetchCommits/fetch-commits-by-author.js';
// when the user is facing a git conflict we should help them understand
// why the conflict occurs. In many cases it's because one or more commits haven't been backported yet
export async function getCommitsWithoutBackports({ options, 
// commit that is being backported
commit, 
// branch the commit is being backported to
targetBranch, 
// the files with conflicts on the target branch
conflictingFiles, }) {
    // commits on the source branch that also touched the conflicting files
    const commitsInConflictingPaths = await fetchCommitsByAuthor({
        ...options,
        author: null, // retrieve commits across all authors
        maxCount: 50,
        since: null,
        until: commit.sourceCommit.committedDate,
        commitPaths: conflictingFiles,
    });
    const promises = await Promise.all(commitsInConflictingPaths
        .filter((c) => {
        // exclude the commit we are currently trying to backport
        if (c.sourceCommit.sha === commit.sourceCommit.sha) {
            return false;
        }
        // exclude commits that are newer than the commit we are trying to backport
        if (c.sourceCommit.committedDate > commit.sourceCommit.committedDate) {
            return false;
        }
        // only consider commits that have an associated pull request
        if (!c.sourcePullRequest?.url) {
            return false;
        }
        // only include commit if it has an unmerged PR for the given target branch
        const hasUnmergedPr = c.targetPullRequestStates.some((pr) => pr.branch === targetBranch && pr.state !== 'MERGED');
        return hasUnmergedPr;
    })
        .slice(0, 10) // limit to max 10 commits
        .map(async (c) => {
        const results = await Promise.all(c.targetPullRequestStates.map(async (targetPr) => {
            if (!targetPr.mergeCommit) {
                return false;
            }
            return getIsCommitInBranch(options, targetPr.mergeCommit.sha);
        }));
        const isCommitInBranch = results.includes(true);
        return { c, isCommitInBranch };
    }));
    return promises
        .filter(({ isCommitInBranch }) => !isCommitInBranch)
        .map(({ c }) => {
        // get pull request for the target branch (if it exists)
        const pendingBackportPr = c.targetPullRequestStates.find((pr) => pr.branch === targetBranch && pr.state === 'OPEN');
        const formatted = pendingBackportPr
            ? ` - ${getFirstLine(c.sourceCommit.message)} ${chalk.gray('(backport pending)')}\n   ${pendingBackportPr.url}`
            : ` - ${getFirstLine(c.sourceCommit.message)} ${chalk.red('(backport missing)')}\n   ${c.sourcePullRequest?.url}`;
        return { formatted, commit: c };
    });
}
//# sourceMappingURL=get-commits-without-backports.js.map