Struct git_cliff_core::release::Release

pub struct Release<'a> {
    pub version: Option<String>,
    pub commits: Vec<Commit<'a>>,
    pub commit_id: Option<String>,
    pub timestamp: i64,
    pub previous: Option<Box<Release<'a>>>,
    pub github: GitHubReleaseMetadata,
}

Representation of a release.

Fields

version: Option<String>

Release version, git tag.

commits: Vec<Commit<'a>>

Commits made for the release.

commit_id: Option<String>

Commit ID of the tag.

timestamp: i64

Timestamp of the release in seconds, from epoch.

previous: Option<Box<Release<'a>>>

Previous release.

github: GitHubReleaseMetadata

Available on crate feature github only.

Contributors.

Implementations

impl<'a> Release<'a>

pub fn update_github_metadata( &mut self, github_commits: Vec<GitHubCommit>, github_pull_requests: Vec<GitHubPullRequest> ) -> Result<()>

Available on crate feature github only.

Updates the GitHub metadata that is contained in the release.

This function takes two arguments:

• GitHub commits: needed for associating the Git user with the GitHub username.
• GitHub pull requests: needed for generating the contributor list for the release.

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

Calculates the next version based on the commits.

It uses the default bump version configuration to calculate the next version.

Trait Implementations

impl<'a> Clone for Release<'a>

fn clone(&self) -> Release<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Release<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Release<'a>

fn default() -> Release<'a>

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for Release<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq for Release<'a>

fn eq(&self, other: &Release<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Serialize for Release<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for Release<'a>