Struct release_utils::Package

pub struct Package { /* private fields */ }

A package in the workspace.

Implementations

impl Package

pub fn new<S>(name: S) -> Self

where S: Into<String>,

Create a Package with the given name.

This uses the current directory as the the workspace path.

pub fn with_workspace<S, P>(name: S, workspace: P) -> Self

where S: Into<String>, P: Into<PathBuf>,

Create a Package with the given name and workspace.

The workspace directory should be the root of the workspace, or just the directory of the package in non-workspace projects.

pub fn name(&self) -> &str

Get the package’s name.

pub fn workspace(&self) -> &Path

Get the package’s root workspace directory.

pub fn get_git_tag_name(&self, local_version: &str) -> String

Format a package version as a git tag.

pub fn get_local_version(&self) -> Result<String>

Use the cargo_metadata crate to get the local version of a package in the workspace.