Struct Package

pub struct Package {
    pub name: Name,
    pub versions: PackageVersions,
    pub release_notes: ReleaseNotes,
    /* private fields */
}

Fields

name: Name

versions: PackageVersions

release_notes: ReleaseNotes

Implementations

impl Package

pub fn new<S: AsRef<str> + Debug>( name: Name, git_tags: &[S], versioned_files_tracked: Vec<Config>, all_versioned_files: &[VersionedFile], release_notes: ReleaseNotes, scopes: Option<Vec<String>>, ) -> Result<Self, Box<NewError>>

Try and combine a bunch of versioned files into one logical package.

Errors

There must be at least one versioned file, and all files must have the same version.

pub fn bump_version( &mut self, bump: Bump, go_versioning: GoVersioning, versioned_files: Vec<VersionedFile>, ) -> Result<Vec<VersionedFile>, BumpError>

Returns the actions that must be taken to set this package to the new version, along with the version it was set to.

The version can either be calculated from a semver rule or specified manually.

Errors

If the file is a go.mod, there are rules about what versions are allowed.

If serialization of some sort fails, which is a bug, then this will return an error.

If the Rule::Release is specified, but there is no current prerelease, that’s an error too.

pub fn get_changes( &self, changeset: &[Release], commit_messages: &[String], ) -> Vec<Change>

pub fn apply_changes( &mut self, changes: &[Change], versioned_files: Vec<VersionedFile>, config: ChangeConfig, ) -> Result<(Vec<VersionedFile>, Vec<Action>), BumpError>

Apply changes to the package, updating the internal version and returning the list of actions to take to complete the changes.

Errors

If the file is a go.mod, there are rules about what versions are allowed.

If serialization of some sort fails, which is a bug, then this will return an error.

Trait Implementations

impl Clone for Package

fn clone(&self) -> Package

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Package

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.