@rushstack/rush-sdk 5.101.1 → 5.102.0-pr3949.5

package/dist/rush-lib.d.ts

@@ -6,6 +6,7 @@
 /// <reference types="node" />
 
 import { AsyncParallelHook } from 'tapable';
+import { AsyncSeriesBailHook } from 'tapable';
 import { AsyncSeriesHook } from 'tapable';
 import { AsyncSeriesWaterfallHook } from 'tapable';
 import type { CollatedWriter } from '@rushstack/stream-collator';
@@ -209,6 +210,62 @@ export declare class ChangeManager {
  */
 export declare type CloudBuildCacheProviderFactory = (buildCacheJson: IBuildCacheJson) => ICloudBuildCacheProvider | Promise<ICloudBuildCacheProvider>;
 
+/**
+ * Use this class to load and save the "common/config/rush/cobuild.json" config file.
+ * This file provides configuration options for the Rush Cobuild feature.
+ * @beta
+ */
+export declare class CobuildConfiguration {
+    private static _jsonSchema;
+    /**
+     * Indicates whether the cobuild feature is enabled.
+     * Typically it is enabled in the cobuild.json config file.
+     *
+     * Note: The orchestrator (or local users) should always have to opt into running with cobuilds by
+     * providing a cobuild context id. Even if cobuilds are "enabled" as a feature, they don't
+     * actually turn on for that particular build unless the cobuild context id is provided as an
+     * non-empty string.
+     */
+    readonly cobuildEnabled: boolean;
+    /**
+     * Cobuild context id
+     *
+     * @remarks
+     * The cobuild feature won't be enabled until the context id is provided as an non-empty string.
+     */
+    readonly cobuildContextId: string | undefined;
+    /**
+     * This is a name of the participating cobuild runner. It can be specified by the environment variable
+     * RUSH_COBUILD_RUNNER_ID. If it is not provided, a random id will be generated to identify the runner.
+     */
+    readonly cobuildRunnerId: string;
+    /**
+     * If true, Rush will automatically handle the leaf project with build cache "disabled" by writing
+     * to the cache in a special "log files only mode". This is useful when you want to use Cobuilds
+     * to improve the performance in CI validations and the leaf projects have not enabled cache.
+     */
+    readonly cobuildLeafProjectLogOnlyAllowed: boolean;
+    private _cobuildLockProvider;
+    private readonly _cobuildLockProviderFactory;
+    private readonly _cobuildJson;
+    private constructor();
+    /**
+     * Attempts to load the cobuild.json data from the standard file path `common/config/rush/cobuild.json`.
+     * If the file has not been created yet, then undefined is returned.
+     */
+    static tryLoadAsync(terminal: ITerminal, rushConfiguration: RushConfiguration, rushSession: RushSession): Promise<CobuildConfiguration | undefined>;
+    static getCobuildConfigFilePath(rushConfiguration: RushConfiguration): string;
+    private static _loadAsync;
+    createLockProviderAsync(terminal: ITerminal): Promise<void>;
+    destroyLockProviderAsync(): Promise<void>;
+    get cobuildLockProvider(): ICobuildLockProvider;
+}
+
+/**
+ * @beta
+ */
+export declare type CobuildLockProviderFactory = (cobuildJson: ICobuildJson) => ICobuildLockProvider | Promise<ICobuildLockProvider>;
+
 /**
  * Use this class to load and save the "common/config/rush/common-versions.json" config file.
  * This config file stores dependency version information that affects all projects in the repo.
@@ -307,6 +364,58 @@ export declare class CredentialCache {
     private _validate;
 }
 
+/**
+ * An identifier representing a Rush message that can be customized by
+ * defining a custom tip in `common/config/rush/custom-tips.json`.
+ * @remarks
+ * Custom tip ids always start with the `TIP_` prefix.
+ *
+ * @privateRemarks
+ * Events from the Rush process should with "TIP_RUSH_".
+ * Events from a PNPM subprocess should start with "TIP_PNPM_".
+ *
+ * @beta
+ */
+export declare type CustomTipId = 'TIP_RUSH_INCONSISTENT_VERSIONS' | string;
+
+/**
+ * Used to access the `common/config/rush/custom-tips.json` config file,
+ * which allows repo maintainers to configure extra details to be printed alongside
+ * certain Rush messages.
+ * @beta
+ */
+export declare class CustomTipsConfiguration {
+    private static _jsonSchema;
+    private readonly _tipMap;
+    private readonly _jsonFileName;
+    /**
+     * The JSON settings loaded from `custom-tips.json`.
+     */
+    readonly configuration: Readonly<ICustomTipsJson>;
+    /**
+     * The list of identifiers that are allowed to be used in the "tipId" field
+     * of the config file.
+     */
+    static readonly supportedTipIds: ReadonlySet<string>;
+    constructor(configFilename: string);
+    private _formatTipMessage;
+    /**
+     * If custom-tips.json defines a tip for the specified tipId,
+     * display the tip on the terminal.
+     */
+    showInfoTip(terminal: ITerminal, tipId: CustomTipId): void;
+    /**
+     * If custom-tips.json defines a tip for the specified tipId,
+     * display the tip on the terminal.
+     */
+    showWarningTip(terminal: ITerminal, tipId: CustomTipId): void;
+    /**
+     * If custom-tips.json defines a tip for the specified tipId,
+     * display the tip on the terminal.
+     */
+    showErrorTip(terminal: ITerminal, tipId: CustomTipId): void;
+}
+
 /**
  * @public
  */
@@ -338,6 +447,10 @@ export declare class EnvironmentConfiguration {
     private static _buildCacheCredential;
     private static _buildCacheEnabled;
     private static _buildCacheWriteAllowed;
+    private static _cobuildEnabled;
+    private static _cobuildContextId;
+    private static _cobuildRunnerId;
+    private static _cobuildLeafProjectLogOnlyAllowed;
     private static _gitBinaryPath;
     private static _tarBinaryPath;
     /**
@@ -393,6 +506,26 @@ export declare class EnvironmentConfiguration {
      * See {@link EnvironmentVariableNames.RUSH_BUILD_CACHE_WRITE_ALLOWED}
      */
     static get buildCacheWriteAllowed(): boolean | undefined;
+    /**
+     * If set, enables or disables the cobuild feature.
+     * See {@link EnvironmentVariableNames.RUSH_COBUILD_ENABLED}
+     */
+    static get cobuildEnabled(): boolean | undefined;
+    /**
+     * Provides a determined cobuild context id if configured
+     * See {@link EnvironmentVariableNames.RUSH_COBUILD_CONTEXT_ID}
+     */
+    static get cobuildContextId(): string | undefined;
+    /**
+     * Provides a determined cobuild runner id if configured
+     * See {@link EnvironmentVariableNames.RUSH_COBUILD_RUNNER_ID}
+     */
+    static get cobuildRunnerId(): string | undefined;
+    /**
+     * If set, enables or disables the cobuild leaf project log only feature.
+     * See {@link EnvironmentVariableNames.RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED}
+     */
+    static get cobuildLeafProjectLogOnlyAllowed(): boolean | undefined;
     /**
      * Allows the git binary path to be explicitly provided.
      * See {@link EnvironmentVariableNames.RUSH_GIT_BINARY_PATH}
@@ -550,6 +683,43 @@ export declare const EnvironmentVariableNames: {
      * this environment variable is ignored.
      */
     readonly RUSH_BUILD_CACHE_WRITE_ALLOWED: "RUSH_BUILD_CACHE_WRITE_ALLOWED";
+    /**
+     * Setting this environment variable overrides the value of `cobuildEnabled` in the `cobuild.json`
+     * configuration file.
+     *
+     * @remarks
+     * Specify `1` to enable the cobuild or `0` to disable it.
+     *
+     * If there is no cobuild configured, then this environment variable is ignored.
+     */
+    readonly RUSH_COBUILD_ENABLED: "RUSH_COBUILD_ENABLED";
+    /**
+     * Setting this environment variable opts into running with cobuilds. The context id should be the same across
+     * multiple VMs, but changed when it is a new round of cobuilds.
+     *
+     * e.g. `Build.BuildNumber` in Azure DevOps Pipeline.
+     *
+     * @remarks
+     * If there is no cobuild configured, then this environment variable is ignored.
+     */
+    readonly RUSH_COBUILD_CONTEXT_ID: "RUSH_COBUILD_CONTEXT_ID";
+    /**
+     * Explicitly specifies a name for each participating cobuild runner.
+     *
+     * Setting this environment variable opts into running with cobuilds.
+     *
+     * @remarks
+     * This environment variable is optional, if it is not provided, a random id is used.
+     *
+     * If there is no cobuild configured, then this environment variable is ignored.
+     */
+    readonly RUSH_COBUILD_RUNNER_ID: "RUSH_COBUILD_RUNNER_ID";
+    /**
+     * If this variable is set to "1", When getting distributed builds, Rush will automatically handle the leaf project
+     * with build cache "disabled" by writing to the cache in a special "log files only mode". This is useful when you
+     * want to use Cobuilds to improve the performance in CI validations and the leaf projects have not enabled cache.
+     */
+    readonly RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED: "RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED";
     /**
      * Explicitly specifies the path for the Git binary that is invoked by certain Rush operations.
      */
@@ -713,6 +883,114 @@ export declare interface ICloudBuildCacheProvider {
     deleteCachedCredentialsAsync(terminal: ITerminal): Promise<void>;
 }
 
+/**
+ * @beta
+ */
+export declare interface ICobuildCompletedState {
+    status: OperationStatus.Success | OperationStatus.SuccessWithWarning | OperationStatus.Failure;
+    /**
+     * Completed state points to the cache id that was used to store the build cache.
+     * Note: Cache failed builds in a separate cache id
+     */
+    cacheId: string;
+}
+
+/**
+ * @beta
+ */
+export declare interface ICobuildContext {
+    /**
+     * The key for acquiring lock.
+     */
+    lockKey: string;
+    /**
+     * The expire time of the lock in seconds.
+     */
+    lockExpireTimeInSeconds: number;
+    /**
+     * The key for storing completed state.
+     */
+    completedStateKey: string;
+    /**
+     * The contextId is provided by the monorepo maintainer, it reads from environment variable {@link EnvironmentVariableNames.RUSH_COBUILD_CONTEXT_ID}.
+     * It ensure only the builds from the same given contextId cooperated.
+     */
+    contextId: string;
+    /**
+     * The id of the cluster. The operations in the same cluster share the same clusterId and
+     * will be executed on the same machine.
+     */
+    clusterId: string;
+    /**
+     * The id of the runner. The identifier for the running machine.
+     *
+     * It can be specified via assigning `RUSH_COBUILD_RUNNER_ID` environment variable.
+     */
+    runnerId: string;
+    /**
+     * The id of the cache entry. It should be kept the same as the normal cacheId from ProjectBuildCache.
+     * Otherwise, there is a discrepancy in the success case wherein turning on cobuilds will
+     * fail to populate the normal build cache.
+     */
+    cacheId: string;
+    /**
+     * The name of NPM package
+     *
+     * Example: `@scope/MyProject`
+     */
+    packageName: string;
+    /**
+     * The name of the phase.
+     *
+     * Example: _phase:build
+     */
+    phaseName: string;
+}
+
+/**
+ * @beta
+ */
+export declare interface ICobuildJson {
+    cobuildEnabled: boolean;
+    cobuildLockProvider: string;
+}
+
+/**
+ * @beta
+ */
+export declare interface ICobuildLockProvider {
+    /**
+     * The callback function invoked to connect to the lock provider.
+     * For example, initializing the connection to the redis server.
+     */
+    connectAsync(): Promise<void>;
+    /**
+     * The callback function invoked to disconnect the lock provider.
+     */
+    disconnectAsync(): Promise<void>;
+    /**
+     * The callback function to acquire a lock with a lock key and specific contexts.
+     *
+     * NOTE: This lock implementation must be a ReentrantLock. It says the lock might be acquired
+     * multiple times, since tasks in the same cluster can be run in the same VM.
+     */
+    acquireLockAsync(context: Readonly<ICobuildContext>): Promise<boolean>;
+    /**
+     * The callback function to renew a lock with a lock key and specific contexts.
+     *
+     * NOTE: If the lock key expired
+     */
+    renewLockAsync(context: Readonly<ICobuildContext>): Promise<void>;
+    /**
+     * The callback function to set completed state.
+     */
+    setCompletedStateAsync(context: Readonly<ICobuildContext>, state: ICobuildCompletedState): Promise<void>;
+    /**
+     * The callback function to get completed state.
+     */
+    getCompletedStateAsync(context: Readonly<ICobuildContext>): Promise<ICobuildCompletedState | undefined>;
+}
+
 /**
  * A collection of environment variables
  * @public
@@ -750,6 +1028,10 @@ export declare interface ICreateOperationsContext {
      * The configuration for the build cache, if the feature is enabled.
      */
     readonly buildCacheConfiguration: BuildCacheConfiguration | undefined;
+    /**
+     * The configuration for the cobuild, if cobuild feature and build cache feature are both enabled.
+     */
+    readonly cobuildConfiguration: CobuildConfiguration | undefined;
     /**
      * The set of custom parameters for the executing command.
      * Maps from the `longName` field in command-line.json to the parser configuration in ts-command-line.
@@ -812,6 +1094,45 @@ export declare interface ICredentialCacheOptions {
     supportEditing: boolean;
 }
 
+/**
+ * An item from the {@link ICustomTipsJson.customTips} list.
+ * @beta
+ */
+export declare interface ICustomTipItemJson {
+    /**
+     * (REQUIRED) An identifier indicating a message that may be printed by Rush.
+     * If that message is printed, then this custom tip will be shown.
+     * Consult the Rush documentation for the current list of possible identifiers.
+     */
+    tipId: CustomTipId;
+    /**
+     * (REQUIRED) The message text to be displayed for this tip.
+     */
+    message: string;
+    /**
+     *  Overrides the "defaultMessagePrefix" for this tip.
+     * Specify an empty string to omit the "defaultMessagePrefix" entirely.
+     */
+    messagePrefix?: string;
+}
+
+/**
+ * This interface represents the raw custom-tips.json file which allows repo maintainers
+ * to configure extra details to be printed alongside certain Rush messages.
+ * @beta
+ */
+export declare interface ICustomTipsJson {
+    /**
+     * If specified, this prefix will be prepended to any the tip messages when they are displayed.
+     * The default value is an empty string.
+     */
+    defaultMessagePrefix?: string;
+    /**
+     *  Specifies the custom tips to be displayed by Rush.
+     */
+    customTips?: ICustomTipItemJson[];
+}
+
 declare interface IEnvironment {
     [environmentVariableName: string]: string | undefined;
 }
@@ -865,6 +1186,12 @@ export declare interface IExperimentsJson {
      * Set this option to true to pass '--prefer-frozen-lockfile' instead.
      */
     usePnpmPreferFrozenLockfileForRushUpdate?: boolean;
+    /**
+     * By default, 'rush update' runs as a single operation.
+     * Set this option to true to instead update the lockfile with `--lockfile-only`, then perform a `--frozen-lockfile` install.
+     * Necessary when using the `afterAllResolved` hook in .pnpmfile.cjs.
+     */
+    usePnpmLockfileOnlyThenFrozenLockfileForRushUpdate?: boolean;
     /**
      * If using the 'preventManualShrinkwrapChanges' option, restricts the hash to only include the layout of external dependencies.
      * Used to allow links between workspace projects or the addition/removal of references to existing dependency versions to not
@@ -1109,6 +1436,10 @@ export declare interface IOperationExecutionResult {
      * The value indicates the duration of the same operation without cache hit.
      */
     readonly nonCachedDurationMs: number | undefined;
+    /**
+     * The id of the runner which actually runs the building process in cobuild mode.
+     */
+    readonly cobuildRunnerId: string | undefined;
 }
 
 /**
@@ -1118,6 +1449,8 @@ export declare interface _IOperationMetadata {
     durationInSeconds: number;
     logPath: string;
     errorLogPath: string;
+    cobuildContextId: string | undefined;
+    cobuildRunnerId: string | undefined;
 }
 
 /**
@@ -1160,10 +1493,6 @@ export declare interface IOperationRunner {
      * Name of the operation, for logging.
      */
     readonly name: string;
-    /**
-     * This flag determines if the operation is allowed to be skipped if up to date.
-     */
-    isSkipAllowed: boolean;
     /**
      * Indicates that this runner's duration has meaning.
      */
@@ -1178,9 +1507,9 @@ export declare interface IOperationRunner {
      */
     warningsAreAllowed: boolean;
     /**
-     * Indicates if the output of this operation may be written to the cache
+     * Full shell command string to run by this runner.
      */
-    isCacheWriteAllowed: boolean;
+    commandToRun?: string;
     /**
      * Method to be executed for the operation.
      */
@@ -1219,6 +1548,25 @@ export declare interface IOperationRunnerContext {
      * Object used to track elapsed time.
      */
     stopwatch: IStopwatchResult;
+    /**
+     * The current execution status of an operation. Operations start in the 'ready' state,
+     * but can be 'blocked' if an upstream operation failed. It is 'executing' when
+     * the operation is executing. Once execution is complete, it is either 'success' or
+     * 'failure'.
+     */
+    status: OperationStatus;
+    /**
+     * Error which occurred while executing this operation, this is stored in case we need
+     * it later (for example to re-print errors at end of execution).
+     */
+    error?: Error;
+    /**
+     * Normally the incremental build logic will rebuild changed projects as well as
+     * any projects that directly or indirectly depend on a changed project.
+     * If true, then the incremental build logic will only rebuild changed projects and
+     * ignore dependent projects.
+     */
+    readonly changedProjectsOnly: boolean;
 }
 
 /**
@@ -1234,6 +1582,8 @@ export declare interface _IOperationStateFileOptions {
  */
 export declare interface _IOperationStateJson {
     nonCachedDurationMs: number;
+    cobuildContextId: string | undefined;
+    cobuildRunnerId: string | undefined;
 }
 
 /**
@@ -2056,7 +2406,7 @@ export declare class _OperationMetadataManager {
      * Example: `.rush/temp/operation/_phase_build/error.log`
      */
     get relativeFilepaths(): string[];
-    saveAsync({ durationInSeconds, logPath, errorLogPath }: _IOperationMetadata): Promise<void>;
+    saveAsync({ durationInSeconds, cobuildContextId, cobuildRunnerId, logPath, errorLogPath }: _IOperationMetadata): Promise<void>;
     tryRestoreAsync({ terminal, logPath, errorLogPath }: {
         terminal: ITerminal;
         logPath: string;
@@ -2099,10 +2449,18 @@ export declare enum OperationStatus {
      * The Operation is on the queue, ready to execute (but may be waiting for dependencies)
      */
     Ready = "READY",
+    /**
+     * The Operation is Queued
+     */
+    Queued = "QUEUED",
     /**
      * The Operation is currently executing
      */
     Executing = "EXECUTING",
+    /**
+     * The Operation is currently executing by a remote process
+     */
+    RemoteExecuting = "REMOTE EXECUTING",
     /**
      * The Operation completed successfully and did not write to standard output
      */
@@ -2260,7 +2618,10 @@ export declare class PhasedCommandHooks {
      * Hook invoked before operation start
      * Hook is series for stable output.
      */
-    readonly beforeExecuteOperations: AsyncSeriesHook<[Map<Operation, IOperationExecutionResult>]>;
+    readonly beforeExecuteOperations: AsyncSeriesHook<[
+    Map<Operation, IOperationExecutionResult>,
+    ICreateOperationsContext
+    ]>;
     /**
      * Hook invoked when operation status changed
      * Hook is series for stable output.
@@ -2272,6 +2633,16 @@ export declare class PhasedCommandHooks {
      * Hook is series for stable output.
      */
     readonly afterExecuteOperations: AsyncSeriesHook<[IExecutionResult, ICreateOperationsContext]>;
+    /**
+     * Hook invoked before executing a operation.
+     */
+    readonly beforeExecuteOperation: AsyncSeriesBailHook<[
+    IOperationRunnerContext
+    ], OperationStatus | undefined>;
+    /**
+     * Hook invoked after executing a operation.
+     */
+    readonly afterExecuteOperation: AsyncSeriesHook<[IOperationRunnerContext]>;
     /**
      * Hook invoked after a run has finished and the command is watching for changes.
      * May be used to display additional relevant data to the user.
@@ -2907,6 +3278,16 @@ export declare class RushConfiguration {
      * @beta
      */
     readonly versionPolicyConfigurationFilePath: string;
+    /**
+     * Accesses the custom-tips.json configuration.
+     * @beta
+     */
+    readonly customTipsConfiguration: CustomTipsConfiguration;
+    /**
+     * The absolute path to the custom tips configuration file.
+     * @beta
+     */
+    readonly customTipsConfigurationFilePath: string;
     /**
      * This configuration object contains settings repo maintainers have specified to enable
      * and disable experimental Rush features.
@@ -3375,6 +3756,12 @@ export declare class RushConstants {
      * store the state of various features as they stand in the repo.
      */
     static readonly repoStateFilename: string;
+    /**
+     * The filename ("custom-tips.json") for the file used by Rush to
+     * print user-customized messages.
+     * This configuration file should go in the "common/config/rush" folder.
+     */
+    static readonly customTipsFilename: string;
     /**
      * The name of the per-project folder where project-specific Rush files are stored. For example,
      * the package-deps files, which are used by commands to determine if a particular project needs to be rebuilt.
@@ -3415,6 +3802,10 @@ export declare class RushConstants {
      * Changing this ensures that cache entries generated by an old version will no longer register as a cache hit.
      */
     static readonly buildCacheVersion: number;
+    /**
+     * Cobuild configuration file.
+     */
+    static readonly cobuildFilename: string;
     /**
      * Per-project configuration filename.
      */
@@ -3584,12 +3975,15 @@ declare class RushPluginsConfiguration {
 export declare class RushSession {
     private readonly _options;
     private readonly _cloudBuildCacheProviderFactories;
+    private readonly _cobuildLockProviderFactories;
     readonly hooks: RushLifecycleHooks;
     constructor(options: IRushSessionOptions);
     getLogger(name: string): ILogger;
     get terminalProvider(): ITerminalProvider;
     registerCloudBuildCacheProviderFactory(cacheProviderName: string, factory: CloudBuildCacheProviderFactory): void;
     getCloudBuildCacheProviderFactory(cacheProviderName: string): CloudBuildCacheProviderFactory | undefined;
+    registerCobuildLockProviderFactory(cobuildLockProviderName: string, factory: CobuildLockProviderFactory): void;
+    getCobuildLockProviderFactory(cobuildLockProviderName: string): CobuildLockProviderFactory | undefined;
 }
 
 /**

package/lib/api/CobuildConfiguration.d.ts

@@ -0,0 +1,71 @@
+import { ITerminal } from '@rushstack/node-core-library';
+import { CobuildLockProviderFactory, RushSession } from '../pluginFramework/RushSession';
+import type { ICobuildLockProvider } from '../logic/cobuild/ICobuildLockProvider';
+import type { RushConfiguration } from './RushConfiguration';
+/**
+ * @beta
+ */
+export interface ICobuildJson {
+    cobuildEnabled: boolean;
+    cobuildLockProvider: string;
+}
+/**
+ * @beta
+ */
+export interface ICobuildConfigurationOptions {
+    cobuildJson: ICobuildJson;
+    rushConfiguration: RushConfiguration;
+    rushSession: RushSession;
+    cobuildLockProviderFactory: CobuildLockProviderFactory;
+}
+/**
+ * Use this class to load and save the "common/config/rush/cobuild.json" config file.
+ * This file provides configuration options for the Rush Cobuild feature.
+ * @beta
+ */
+export declare class CobuildConfiguration {
+    private static _jsonSchema;
+    /**
+     * Indicates whether the cobuild feature is enabled.
+     * Typically it is enabled in the cobuild.json config file.
+     *
+     * Note: The orchestrator (or local users) should always have to opt into running with cobuilds by
+     * providing a cobuild context id. Even if cobuilds are "enabled" as a feature, they don't
+     * actually turn on for that particular build unless the cobuild context id is provided as an
+     * non-empty string.
+     */
+    readonly cobuildEnabled: boolean;
+    /**
+     * Cobuild context id
+     *
+     * @remarks
+     * The cobuild feature won't be enabled until the context id is provided as an non-empty string.
+     */
+    readonly cobuildContextId: string | undefined;
+    /**
+     * This is a name of the participating cobuild runner. It can be specified by the environment variable
+     * RUSH_COBUILD_RUNNER_ID. If it is not provided, a random id will be generated to identify the runner.
+     */
+    readonly cobuildRunnerId: string;
+    /**
+     * If true, Rush will automatically handle the leaf project with build cache "disabled" by writing
+     * to the cache in a special "log files only mode". This is useful when you want to use Cobuilds
+     * to improve the performance in CI validations and the leaf projects have not enabled cache.
+     */
+    readonly cobuildLeafProjectLogOnlyAllowed: boolean;
+    private _cobuildLockProvider;
+    private readonly _cobuildLockProviderFactory;
+    private readonly _cobuildJson;
+    private constructor();
+    /**
+     * Attempts to load the cobuild.json data from the standard file path `common/config/rush/cobuild.json`.
+     * If the file has not been created yet, then undefined is returned.
+     */
+    static tryLoadAsync(terminal: ITerminal, rushConfiguration: RushConfiguration, rushSession: RushSession): Promise<CobuildConfiguration | undefined>;
+    static getCobuildConfigFilePath(rushConfiguration: RushConfiguration): string;
+    private static _loadAsync;
+    createLockProviderAsync(terminal: ITerminal): Promise<void>;
+    destroyLockProviderAsync(): Promise<void>;
+    get cobuildLockProvider(): ICobuildLockProvider;
+}
+//# sourceMappingURL=CobuildConfiguration.d.ts.map

package/lib/api/CobuildConfiguration.js

@@ -0,0 +1 @@
+module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/CobuildConfiguration");