Function handle_changelog_command

Source
pub async fn handle_changelog_command(
    common: CommonParams,
    from: String,
    to: Option<String>,
    repository_url: Option<String>,
    update_file: bool,
    changelog_path: Option<String>,
    version_name: Option<String>,
) -> Result<()>
Expand description

Handles the changelog generation command.

This function orchestrates the process of generating a changelog based on the provided parameters. It sets up the necessary environment, creates a GitRepo instance, and delegates the actual generation to the ChangelogGenerator.

§Arguments

  • common - Common parameters for the command, including configuration overrides.
  • from - The starting point (commit or tag) for the changelog.
  • to - The ending point for the changelog. Defaults to “HEAD” if not provided.
  • repository_url - Optional URL of the remote repository to use.
  • update_file - Whether to update the changelog file.
  • changelog_path - Optional path to the changelog file.
  • version_name - Optional version name to use instead of extracting from Git refs.

§Returns

Returns a Result indicating success or containing an error if the operation failed.