ChangelogCommand class

Turns the git history into release notes.

The output is meant to be pasted into a store listing or a GitHub release, which is why the default range is "since the previous tag" rather than the whole history: that is what one release actually contains.

The same generator backs the ${{CHANGELOG}} variable, so a pipeline can feed it straight into release-notes or release-body without a wrapper script — see ChangelogSettings.

Inheritance

Object
Command<int>
Commander
ChangelogCommand

Constructors

ChangelogCommand({AiProvider providerFactory(AiConfig config)?}): Creates the changelog command.

Properties

aliases → List<String>: Alternate names for this command.
no setterinherited
argParser → ArgParser: The argument parser for this command.
no setteroverride
argResults → ArgResults?: The parsed argument results for this command.
no setterinherited
category → String: The command's category.
no setterinherited
configPath → String: The configuration file this command should read.
no setterinherited
description → String: A description of this command, included in usage.
no setteroverride
globalResults → ArgResults?: The parsed global argument results.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
hidden → bool: Whether or not this command should be hidden from help listings.
no setterinherited
invocation → String: A single-line template for how to invoke this command (e.g. "pub get package").
no setterinherited
logger → ColorizeLogger: The logger used by this command.
no setterinherited
name → String: The name of this command.
no setteroverride
parent → Command<int>?: The command's parent command, if this is a subcommand.
no setterinherited
providerFactory ↔ AiProvider Function(AiConfig config)?: Overrides the provider for tests.
getter/setter pair
runner → CommandRunner<int>?: The command runner for this command.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
subcommands → Map<String, Command<int>>: An unmodifiable view of all sublevel commands of this command.
no setterinherited
suggestionAliases → List<String>: Alternate non-functional names for this command.
no setterinherited
summary → String: A short description of this command, included in parent's CommandRunner.usage.
no setterinherited
takesArguments → bool: Whether or not this command takes positional arguments in addition to options.
no setterinherited
usage → String: Generates a string displaying usage information for this command.
no setterinherited
usageFooter → String?: An optional footer for usage.
no setterinherited

Methods

addSubcommand(Command<int> command) → void: Adds Command as a subcommand of this.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
printUsage() → void: Prints the usage information for this command.
inherited
run() → Future<int>: Runs this command.
override
toString() → String: A string representation of this object.
inherited
usageException(String message) → Never: Throws a UsageException with message.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

sanitize(String value) → String: Strips everything that could make the printed notes differ from the written ones.

Constants

defaultPrompt → const String: What the model is told to do with the generated notes.