rush-lib.icobuildcontext.md

hide_title	true
custom_edit_url
pagination_prev
pagination_next

Home > @microsoft/rush-lib > ICobuildContext

ICobuildContext interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Signature:

export interface ICobuildContext 

Properties

Property	Modifiers	Type	Description
cacheId		string	(BETA) 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.
clusterId		string	(BETA) The id of the cluster. The operations in the same cluster share the same clusterId and will be executed on the same machine.
completedStateKey		string	(BETA) The key for storing completed state.
contextId		string	(BETA) The contextId is provided by the monorepo maintainer, it reads from environment variable . It ensure only the builds from the same given contextId cooperated.
lockExpireTimeInSeconds		number	(BETA) The expire time of the lock in seconds.
lockKey		string	(BETA) The key for acquiring lock.
packageName		string	(BETA) The name of NPM package Example: @scope/MyProject
phaseName		string	(BETA) The name of the phase. Example: _phase:build
runnerId		string	(BETA) The id of the runner. The identifier for the running machine. It can be specified via assigning RUSH_COBUILD_RUNNER_ID environment variable.