/*! * Copyright (c) Microsoft Corporation and contributors. All rights reserved. * Licensed under the MIT License. */ import { type StateHandlerFunction } from "./stateHandlers.js"; /** * Checks that the current branch matches the expected branch for a release. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkBranchName: StateHandlerFunction; /** * Checks that the branch is up-to-date with the remote branch. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkBranchUpToDate: StateHandlerFunction; /** * Checks if the release group releases from a release branch or not. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkDoesReleaseFromReleaseBranch: StateHandlerFunction; /** * Checks that the repo has a remote configured for the microsoft/FluidFramework repo. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkHasRemote: StateHandlerFunction; /** * Checks that the dependencies of a release group or package are installed. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkDependenciesInstalled: StateHandlerFunction; /** * Checks that the main and next branches are integrated. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkMainNextIntegrated: StateHandlerFunction; /** * Checks that the repo is currently on the expected release branch. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkOnReleaseBranch: StateHandlerFunction; export declare const checkNoPrereleaseDependencies: StateHandlerFunction; /** * Runs the `check policy` command to check for policy violations in the repo. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkPolicy: StateHandlerFunction; /** * Checks that a release branch exists. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkAssertTagging: StateHandlerFunction; /** * Checks that release notes have been generated. * * If release notes exist, then this function will send the "success" action to the state machine and return `true`. The * state machine will transition to the appropriate state based on the "success" action. * * If release notes have not been generated, then this function will send the "failure" action to the state machine and * still return `true`, since the state has been handled. The state machine will transition to the appropriate state * based on the "failure" action. * * Once this function returns, the state machine's state will be reevaluated and passed to another state handler. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. In test mode, the function returns true immediately. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkReleaseNotes: StateHandlerFunction; /** * Checks that changelogs have been generated. * * If changelogs have been generated for the current release, then this function will send the "success" action to the * state machine and return `true`. The state machine will transition to the appropriate state based on the "success" * action. * * If changelogs have not been generated, then this function will send the "failure" action to the state machine and * still return `true`, since the state has been handled. The state machine will transition to the appropriate state * based on the "failure" action. * * Once this function returns, the state machine's state will be reevaluated and passed to another state handler. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. In test mode, the function returns true immediately. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkChangelogs: StateHandlerFunction; /** * Checks that a release branch exists. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkReleaseBranchExists: StateHandlerFunction; /** * Checks that a release group has been bumped. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkReleaseGroupIsBumped: StateHandlerFunction; /** * Checks that the version of the release group or package in the repo has already been released. If this check * succeeds, it means that a bump is needed to bump the repo to the next version. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkReleaseIsDone: StateHandlerFunction; /** * Checks whether changes should be committed automatically. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkShouldCommit: StateHandlerFunction; /** * Checks whether changes should be committed automatically. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkShouldCommitReleasedDepsBump: StateHandlerFunction; /** * Checks whether optional checks should be run. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkShouldRunOptionalChecks: StateHandlerFunction; /** * Checks that typetests:gen has been run. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkTypeTestGenerate: StateHandlerFunction; /** * Checks that typetests: prepare has been run. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkTypeTestPrepare: StateHandlerFunction; /** * Checks that release group is known and valid. * * @param state - The current state machine state. * @param machine - The state machine. * @param testMode - Set to true to run function in test mode. * @param log - A logger that the function can use for logging. * @param data - An object with handler-specific contextual data. * @returns True if the state was handled; false otherwise. */ export declare const checkValidReleaseGroup: StateHandlerFunction; //# sourceMappingURL=checkFunctions.d.ts.map