Struct git_iris::changes::ReleaseNotesGenerator
source · pub struct ReleaseNotesGenerator;Expand description
Struct responsible for generating release notes
Implementations§
source§impl ReleaseNotesGenerator
impl ReleaseNotesGenerator
sourcepub async fn generate(
repo_path: &Path,
from: &str,
to: &str,
config: &Config,
detail_level: DetailLevel,
) -> Result<String>
pub async fn generate( repo_path: &Path, from: &str, to: &str, config: &Config, detail_level: DetailLevel, ) -> Result<String>
Generates release notes for the specified range of commits.
§Arguments
repo_path- Path to the Git repositoryfrom- Starting point for the release notes (e.g., a commit hash or tag)to- Ending point for the release notes (e.g., a commit hash, tag, or “HEAD”)config- Configuration object containing LLM settingsdetail_level- Level of detail for the release notes (Minimal, Standard, or Detailed)
§Returns
A Result containing the generated release notes as a String, or an error
Auto Trait Implementations§
impl Freeze for ReleaseNotesGenerator
impl RefUnwindSafe for ReleaseNotesGenerator
impl Send for ReleaseNotesGenerator
impl Sync for ReleaseNotesGenerator
impl Unpin for ReleaseNotesGenerator
impl UnwindSafe for ReleaseNotesGenerator
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
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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>
Converts
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>
Converts
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