ChangelogGenerator class
changelog-lib is a package that implement the basic blocks to create a changelog from a list of metadata pattern contained inside the commit body,
The usage of the commit body enable the possibility to leave the head of the commit free for the repository guide line and the communication between open source developers, and use the commit body to insert metadata useful for the changelog generation
author: https://github.com/vincenzopalazzo Changelog Generator is the main class that contains all the utils to fetch a list of commit and generate run the checking in the body message to generate the correct changelog.
Constructors
- ChangelogGenerator({required String packageName, required GenericFetcher fetcher})
Properties
- fetcher → GenericFetcher
-
The fetcher that the user decide
to use in order to receive the commit information.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- packageName → String
-
The name of the package/tool/lib
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
addFilterRule(
{required FilterRule rule}) → void - method to add a new filter rule to generate a new section in the changelog.
-
generate(
{required String versionName}) → Future< ChangelogInfo> - Generate is the main method to generate the changelog in a String so the final user of this library can store the information in any order way that he want.
-
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