VersionCommandConfigs class

Configurations for melos version.

Annotations
  • @immutable

Constructors

VersionCommandConfigs({String? branch, String? message, bool includeScopes = true, bool linkToCommits = false, bool includeCommitId = false, bool includeCommitBody = false, bool commitBodyOnlyBreaking = true, bool updateGitTagRefs = false, bool releaseUrl = false, List<AggregateChangelogConfig>? aggregateChangelogs, bool fetchTags = true, VersionLifecycleHooks hooks = VersionLifecycleHooks.empty})
const
VersionCommandConfigs.fromYaml(Map<Object?, Object?> yaml, {required String workspacePath, bool repositoryIsConfigured = false})
factory

Properties

aggregateChangelogs List<AggregateChangelogConfig>
A list of changelogs configurations that will be used to generate changelogs which describe the changes in multiple packages.
no setter
branch String?
If specified, prevents melos version from being used inside branches other than the one specified.
final
commitBodyOnlyBreaking bool
Whether to only include commit bodies for breaking changes.
final
fetchTags bool
Whether to fetch tags from the origin remote before versioning.
final
hashCode int
The hash code for this object.
no setteroverride
hooks → VersionLifecycleHooks
Lifecycle hooks for this command.
final
includeCommitBody bool
Wheter to include commit bodies in the generated CHANGELOG.md.
final
includeCommitId bool
Whether to add commits ids in the generated CHANGELOG.md.
final
includeScopes bool
Whether to include conventional commit scopes in the generated CHANGELOG.md.
final
linkToCommits bool
Whether to add links to commits in the generated CHANGELOG.md.
final
message String?
A custom header for the generated CHANGELOG.md.
final
releaseUrl bool
Whether to generate and print a link to the prefilled release creation page for each package after versioning.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
updateGitTagRefs bool
Whether to also update pubspec with git referenced packages.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, Object?>
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
override

Constants

empty → const VersionCommandConfigs