Struct ChangelogGenerator

pub struct ChangelogGenerator;

Struct responsible for generating changelogs

Implementations

impl ChangelogGenerator

pub async fn generate( git_repo: Arc<GitRepo>, from: &str, to: &str, config: &Config, detail_level: DetailLevel, ) -> Result<String>

Generates a changelog for the specified range of commits.

Arguments

• git_repo - GitRepo instance
• from - Starting point for the changelog (e.g., a commit hash or tag)
• to - Ending point for the changelog (e.g., a commit hash, tag, or “HEAD”)
• config - Configuration object containing LLM settings
• detail_level - Level of detail for the changelog (Minimal, Standard, or Detailed)

Returns

A Result containing the generated changelog as a String, or an error

pub fn update_changelog_file( changelog_content: &str, changelog_path: &str, git_repo: &Arc<GitRepo>, to_ref: &str, version_name: Option<String>, ) -> Result<()>

Updates a changelog file with new content

This function reads the existing changelog file (if it exists), preserves the header, and prepends the new changelog content while maintaining the file structure.

Arguments

• changelog_content - The new changelog content to prepend
• changelog_path - Path to the changelog file
• git_repo - GitRepo instance to use for retrieving commit dates
• to_ref - The “to” Git reference (commit/tag) to extract the date from
• version_name - Optional custom version name to use instead of version from Git

Returns

A Result indicating success or an error