Enum ChangelogCommands 

pub enum ChangelogCommands {
    Generate {
        output: PathBuf,
        from: Option<String>,
        to: Option<String>,
        filter: Option<String>,
        dry_run: bool,
    },
    Validate {
        file: PathBuf,
        strict: bool,
        json: bool,
    },
    Release {
        version: String,
        date: Option<String>,
        from_commits: bool,
        dry_run: bool,
    },
    Export {
        input: PathBuf,
        output: PathBuf,
        format: String,
        version: Option<String>,
    },
    Add {
        entry_type: String,
        description: String,
        unreleased: bool,
        version: Option<String>,
    },
    Stats {
        file: PathBuf,
        json: bool,
    },
}

Variants

Generate

Generate changelog from git commits

Fields

output: PathBuf

Output file path (defaults to CHANGELOG.md)

from: Option<String>

Start from this tag/commit

to: Option<String>

End at this tag/commit (defaults to HEAD)

filter: Option<String>

Include only commits matching pattern

dry_run: bool

Preview without writing file

Validate

Validate changelog format

Fields

file: PathBuf

Changelog file to validate (defaults to CHANGELOG.md)

strict: bool

Check for Keep a Changelog compliance

json: bool

Output validation report as JSON

Release

Prepare a new release section

Fields

version: String

Version number for the release

date: Option<String>

Release date (defaults to today)

from_commits: bool

Generate from commits since last release

dry_run: bool

Preview without writing file

Export

Export changelog to different formats

Fields

input: PathBuf

Input changelog file (defaults to CHANGELOG.md)

output: PathBuf

Output file path

format: String

Export format (json, html, xml)

version: Option<String>

Include only specific version

Add

Add a changelog entry

Fields

entry_type: String

Entry type (added, changed, deprecated, removed, fixed, security)

description: String

Entry description

unreleased: bool

Add to unreleased section

version: Option<String>

Specific version to add to

Stats

Show changelog statistics

Fields

file: PathBuf

Changelog file (defaults to CHANGELOG.md)

json: bool

Output as JSON

Trait Implementations

impl FromArgMatches for ChangelogCommands

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for ChangelogCommands

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand