ChangelogOptions class

The subset of the changelog: section that ${{CHANGELOG}} needs.

A plain value object so BuiltinVariables stays independent of the configuration parser and remains trivially testable.

Constructors

ChangelogOptions({String? from, bool group = true, bool includeShas = false, bool includeMerges = false, int? limit, ChangelogFormat format = ChangelogFormat.markdown})
Creates the options.
const

Properties

format ChangelogFormat
How ${{CHANGELOG}} is 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
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