ChangelogSettings class

The changelog: section of distribution.yaml.

Defaults chosen so that ${{CHANGELOG}} is useful with no configuration at all: markdown, grouped, since the previous tag.

Constructors

ChangelogSettings({String? from, ChangelogFormat format = ChangelogFormat.markdown, bool group = true, bool includeShas = false, bool includeMerges = false, int? limit, bool ai = false, String? prompt})
Creates the settings.
const
ChangelogSettings.fromYaml(Map<String, dynamic> yaml)
Reads the settings from the raw changelog: mapping.
factory

Properties

ai → bool
Whether ${{CHANGELOG}} is polished by the model.
final
format → ChangelogFormat
How the notes are rendered.
final
from → String?
Start of the range. Null means "the previous tag".
final
group → bool
Whether markdown output is grouped by conventional commit type.
final
hashCode → int
The hash code for this object.
no setterinherited
includeMerges → bool
Whether merge commits are listed.
final
includeShas → bool
Whether each line carries its short commit hash.
final
limit → int?
Cap on the number of commits read.
final
prompt → String?
Overrides the instruction sent with --ai.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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