projen/lib/github/auto-merge.d.ts

CDK for software projects

import { GitHub } from "./github";
import { Component } from "../component";
export interface AutoMergeOptions {
    /**
     * Number of approved code reviews.
     * @default 1
     */
    readonly approvedReviews?: number;
    /**
     * List of labels that will prevent auto-merging.
     * @default ['do-not-merge']
     */
    readonly blockingLabels?: string[];
    /**
     * Name of the mergify rule
     * @default 'Automatic merge on approval and successful build'
     */
    readonly ruleName?: string;
    /**
     * Name of the mergify queue
     * @default 'default'
     */
    readonly queueName?: string;
}
/**
 * Automatically merge Pull Requests using Mergify
 *
 * > [!NOTE]
 * > GitHub now natively provides the same features, so you don't need Mergify
 * > anymore. See `GitHubOptions.mergeQueue` and `MergeQueueOptions.autoQueue`.
 *
 * If `buildJob` is specified, the specified GitHub workflow job ID is required
 * to succeed in order for the PR to be merged.
 *
 * `approvedReviews` specified the number of code review approvals required for
 * the PR to be merged.
 *
 * @see https://mergify.com/
 */
export declare class AutoMerge extends Component {
    private readonly lazyConditions;
    constructor(github: GitHub, options?: AutoMergeOptions);
    /**
     * Adds conditions to the auto merge rule.
     * @param conditions The conditions to add (mergify syntax)
     */
    addConditions(...conditions: string[]): void;
    /**
     * Adds conditions that will be rendered only during synthesis.
     * @param later The later
     */
    addConditionsLater(later: IAddConditionsLater): void;
    private renderConditions;
}
export interface IAddConditionsLater {
    render(): string[];
}