git-iris 2.0.8

AI-powered Git workflow assistant for smart commits, code reviews, changelogs, and release notes
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

//! Release notes types and formatting
//!
//! This module provides markdown-based release notes output that lets the LLM drive
//! the structure while we beautify it for terminal display.

use crate::types::review::render_markdown_for_terminal;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Markdown-based release notes that lets the LLM determine structure
#[derive(Serialize, Deserialize, Debug, Clone, JsonSchema)]
pub struct MarkdownReleaseNotes {
    /// The full markdown content of the release notes
    pub content: String,
}

impl MarkdownReleaseNotes {
    /// Render the markdown content with terminal styling
    #[must_use]
    pub fn format(&self) -> String {
        render_markdown_for_terminal(&self.content)
    }

    /// Get the raw markdown content (for file output, etc.)
    #[must_use]
    pub fn raw_content(&self) -> &str {
        &self.content
    }
}