pub struct VersionPlanner;Expand description
Plans version releases by aggregating changesets and calculating new versions.
Implementations§
Source§impl VersionPlanner
impl VersionPlanner
Sourcepub fn plan_releases(
changesets: &[Changeset],
packages: &[PackageInfo],
) -> Result<ReleasePlan, VersionError>
pub fn plan_releases( changesets: &[Changeset], packages: &[PackageInfo], ) -> Result<ReleasePlan, VersionError>
Plans version releases based on changesets.
§Errors
Returns VersionError if version calculation fails.
Sourcepub fn plan_releases_with_prerelease(
changesets: &[Changeset],
packages: &[PackageInfo],
prerelease: Option<&PrereleaseSpec>,
) -> Result<ReleasePlan, VersionError>
pub fn plan_releases_with_prerelease( changesets: &[Changeset], packages: &[PackageInfo], prerelease: Option<&PrereleaseSpec>, ) -> Result<ReleasePlan, VersionError>
Plans version releases with optional prerelease specification.
§Errors
Returns VersionError if version calculation fails.
Sourcepub fn plan_graduation(
packages: &[PackageInfo],
) -> Result<ReleasePlan, VersionError>
pub fn plan_graduation( packages: &[PackageInfo], ) -> Result<ReleasePlan, VersionError>
Plans graduation of prerelease versions to stable.
§Errors
Returns VersionError if version calculation fails.
Sourcepub fn plan_releases_with_behavior(
changesets: &[Changeset],
packages: &[PackageInfo],
prerelease: Option<&PrereleaseSpec>,
zero_behavior: ZeroVersionBehavior,
) -> Result<ReleasePlan, VersionError>
pub fn plan_releases_with_behavior( changesets: &[Changeset], packages: &[PackageInfo], prerelease: Option<&PrereleaseSpec>, zero_behavior: ZeroVersionBehavior, ) -> Result<ReleasePlan, VersionError>
Plans version releases with special handling for 0.x versions.
§Errors
Returns VersionError if version calculation fails.
Sourcepub fn plan_zero_graduation(
packages: &[PackageInfo],
prerelease: Option<&PrereleaseSpec>,
) -> Result<ReleasePlan, VersionError>
pub fn plan_zero_graduation( packages: &[PackageInfo], prerelease: Option<&PrereleaseSpec>, ) -> Result<ReleasePlan, VersionError>
Plans graduation of 0.x versions to 1.0.0.
§Errors
Returns VersionError if version calculation fails.
Sourcepub fn plan_releases_per_package(
changesets: &[Changeset],
packages: &[PackageInfo],
per_package_config: &HashMap<String, PackageReleaseConfig>,
zero_behavior: ZeroVersionBehavior,
) -> Result<ReleasePlan, VersionError>
pub fn plan_releases_per_package( changesets: &[Changeset], packages: &[PackageInfo], per_package_config: &HashMap<String, PackageReleaseConfig>, zero_behavior: ZeroVersionBehavior, ) -> Result<ReleasePlan, VersionError>
Plans version releases with per-package configuration.
This method applies individual prerelease tags and graduation settings to each package based on the validated configuration from CLI + TOML.
§Errors
Returns VersionError if version calculation fails.
pub fn aggregate_bumps( changesets: &[Changeset], ) -> IndexMap<String, Vec<BumpType>>
Sourcepub fn partition_packages(
changesets: &[Changeset],
packages: &[PackageInfo],
) -> (HashSet<String>, Vec<PackageInfo>)
pub fn partition_packages( changesets: &[Changeset], packages: &[PackageInfo], ) -> (HashSet<String>, Vec<PackageInfo>)
Identifies packages that have changesets and those without.
Auto Trait Implementations§
impl Freeze for VersionPlanner
impl RefUnwindSafe for VersionPlanner
impl Send for VersionPlanner
impl Sync for VersionPlanner
impl Unpin for VersionPlanner
impl UnsafeUnpin for VersionPlanner
impl UnwindSafe for VersionPlanner
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more