scrat 0.1.0

Release management tooling focused on sanity retention
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

//! Notes command — thin CLI layer over `scrat_core::notes::preview_notes`.

use anyhow::{Context, bail};
use clap::Args;
use tracing::{debug, instrument};

use scrat_core::config::Config;
use scrat_core::notes::{self, PreviewNotesOptions};

/// Arguments for the `notes` subcommand.
#[derive(Args, Debug, Default)]
pub struct NotesArgs {
    /// Previous version tag to diff against (default: latest semver tag)
    #[arg(long, value_name = "TAG")]
    pub from: Option<String>,

    /// Version to render notes for (default: current version from project files)
    #[arg(long, value_name = "VERSION")]
    pub version: Option<String>,

    /// Path to a custom git-cliff template (overrides config and built-in)
    #[arg(long, value_name = "FILE")]
    pub template: Option<String>,

    /// Skip dependency diff in rendered notes
    #[arg(long)]
    pub no_deps: bool,

    /// Skip stats collection in rendered notes
    #[arg(long)]
    pub no_stats: bool,
}

/// Execute the notes command.
#[instrument(name = "cmd_notes", skip_all)]
pub fn cmd_notes(
    args: NotesArgs,
    global_json: bool,
    config: &Config,
    cwd: &camino::Utf8Path,
) -> anyhow::Result<()> {
    debug!("rendering release notes preview");

    let options = PreviewNotesOptions {
        from: args.from,
        version: args.version,
        template: args.template,
        no_deps: args.no_deps,
        no_stats: args.no_stats,
    };

    let result =
        notes::preview_notes(cwd, config, options).context("failed to render release notes")?;

    if result.notes.trim().is_empty() {
        bail!("git-cliff produced empty output — check that there are unreleased commits");
    }

    if global_json {
        println!("{}", serde_json::to_string_pretty(&result)?);
    } else {
        print!("{}", result.notes);
    }

    Ok(())
}