rush-lib.versionpolicy.md

hide_title	true
custom_edit_url
pagination_prev
pagination_next

Home > @microsoft/rush-lib > VersionPolicy

VersionPolicy class

This is the base class for version policy which controls how versions get bumped.

Signature:

export declare abstract class VersionPolicy 

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the VersionPolicy class.

Properties

Property	Modifiers	Type	Description
definitionName	readonly	VersionPolicyDefinitionName	Version policy definition name
exemptFromRushChange	readonly	boolean	Determines if a version policy wants to opt out of changelog files.
includeEmailInChangeFile	readonly	boolean	Determines if a version policy wants to opt in to including email.
isLockstepped	readonly	boolean	Whether it is a lockstepped version policy
policyName	readonly	string	Version policy name

Methods

Method	Modifiers	Description
bump(bumpType, identifier)	abstract	Bumps version based on the policy
ensure(project, force)	abstract	Returns an updated package json that satisfies the policy.
setDependenciesBeforeCommit(packageName, configuration)
setDependenciesBeforeCommitAsync(packageName, configuration)		Tells the version policy to modify any dependencies in the target package to values used for checked-in source.
setDependenciesBeforePublish(packageName, configuration)
setDependenciesBeforePublishAsync(packageName, configuration)		Tells the version policy to modify any dependencies in the target package to values used for publishing.
validate(versionString, packageName)	abstract	Validates the specified version and throws if the version does not satisfy the policy.