mtrust_api_guard 6.0.1

A package to generate and compare API docs

6.0.1

Released on: 2/23/2026, changelog automatically generated.

Features

• parameterize pre-release prefix (0a237bc)
• add pre-release prefix option for versioning (ce427f4)

6.0.0

Released on: 2/20/2026, changelog automatically generated.

Features

• Use git worktrees to generate analysis (#15) (0a14157)

API Changes

💣 Breaking changes

enum ApiChangeOperation (lib/doc_comparator/api_change.dart)

• ❌ Property removed: platformConstraintChange

✨ Minor changes

enum ApiChangeOperation (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: minDartSdkVersionDecrease, minDartSdkVersionIncrease, maxDartSdkVersionDecrease, maxDartSdkVersionIncrease, minFlutterSdkVersionIncrease, maxFlutterSdkVersionDecrease, maxFlutterSdkVersionIncrease, minFlutterSdkVersionDecrease, minAndroidSdkVersionDecrease, minAndroidSdkVersionIncrease, minIosSdkVersionDecrease, minIosSdkVersionIncrease

class ComponentApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: toString

class ConstructorApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: toString

class ConstructorParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: toString

class MetaApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Constructors added: minDartSdkVersionDecrease, minDartSdkVersionIncrease, maxDartSdkVersionDecrease, maxDartSdkVersionIncrease, minFlutterSdkVersionDecrease, minFlutterSdkVersionIncrease, maxFlutterSdkVersionDecrease, maxFlutterSdkVersionIncrease, minAndroidSdkVersionDecrease, minAndroidSdkVersionIncrease, minIosSdkVersionDecrease, minIosSdkVersionIncrease
• ❇️ Method added: toString

class MethodApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: toString

class MethodParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: toString

class PackageMetadata (lib/models/package_info.dart)

• ❇️ Param added in default constructor: flutterVersion (named, optional)
• ❇️ Property added: flutterVersion

class ParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: toString

class PropertyApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: toString

👀 Patch changes

meta dependency recase (pubspec.yaml)

• 📦 Dependency added: with version ^4.1.0

5.1.0

Released on: 1/19/2026, changelog automatically generated.

Features

• support entry point analysis and package selection for magnitude overrides (2a25b12)
• enhance API guard configuration with entry points and package selection for magnitude overrides (fb31d32)

API Changes

✨ Minor changes

class DocComponent (lib/models/doc_items.dart)

• ❇️ Params added in default constructor: entryPoint (named, optional), superClassPackages (named, optional, default: const [])
• ❇️ Properties added: entryPoint, superClassPackages

5.0.0

Released on: 1/19/2026, changelog automatically generated.

Bug Fixes

• update link to ApiChangeOperation documentation in README (302d88a)
• correct entity name formatting in removal operation and update changelog parameter removal description (e86651d)

Features

• add support for granular magnitude overrides configuration (1e8628a)
• collect all super classes for components and enhance magnitude override configuration (b3e81a8)
• collect all super classes for components and enhance magnitude override configuration (6c5e162)
• update MagnitudeOverride to support multiple operations and enhance matching logic (f399fbb)
• enhance magnitude override configuration with selection criteria (d5e4d72)
• implement magnitude override configuration (da4629c)

API Changes

💣 Breaking changes

enum ApiChangeOperation (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: defaultMagnitude (positional, required)
• ❌ Properties removed: added, removed, renamed, reordered, typeChanged, becameOptional, becameRequired, becameNamed, becamePositional, becameNullUnsafe, becameNullSafe, becamePrivate, becamePublic, annotationAdded, annotationRemoved, dependencyAdded, dependencyRemoved, dependencyChanged, platformConstraintChanged, superClassChanged, interfaceAdded, interfaceRemoved, mixinAdded, mixinRemoved, typeParametersChanged, featureAdded, featureRemoved

enum ApiChangeTarget (lib/doc_comparator/api_change_formatter.dart)

• ❌ Enum removed: ApiChangeTarget

class DocComponent (lib/models/doc_items.dart)

• ❌ Param removed in default constructor: isNullSafe (named, required)
• ❌ Constructor removed: metadata
• ❌ Properties removed: isNullSafe, superClass

enum DocComponentType (lib/models/doc_items.dart)

• ❌ Properties removed: dependencyType, platformConstraintType

✨ Minor changes

class ApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: overrideMagnitude

extension ApiChangeFormattingHelpers (lib/doc_comparator/api_change_formatter.dart)

• ❇️ Extension added: ApiChangeFormattingHelpers

enum ApiChangeMagnitude (lib/doc_comparator/api_change.dart)

• ❇️ Property added: ignore

enum ApiChangeOperation (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: addition, removal, renaming, typeChange, typeParametersChange, becomingPrivate, becomingPublic, becomingOptional, becomingRequired, becomingNullable, becomingNonNullable, becomingNamed, becomingPositional, reordering, annotationAddition, annotationRemoval, superClassChange, interfaceImplementation, interfaceRemoval, mixinApplication, mixinRemoval, dependencyVersionChange, dependencyAddition, dependencyRemoval, platformConstraintChange, featureAddition, featureRemoval, defaultMagnitude

class ApiGuardConfig (lib/config/config.dart)

• ❇️ Param added in default constructor: magnitudeOverrides (named, optional, default: const [])
• ❇️ Property added: magnitudeOverrides
• ❇️ Param added in method copyWith: magnitudeOverrides (named, optional)
• ❇️ Method added: load

class ComponentApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: overrideMagnitude

class ConstructorApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: overrideMagnitude

class ConstructorParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: overrideMagnitude

class DocComponent (lib/models/doc_items.dart)

• ❌ Param removed in default constructor: superClass (named, optional)
• ❇️ Param added in default constructor: superClasses (named, optional, default: const [])
• ❇️ Constructor added: meta
• ❇️ Property added: superClasses

enum DocComponentType (lib/models/doc_items.dart)

• ❇️ Property added: metaType

class MagnitudeOverride (lib/config/magnitude_override.dart)

• ❇️ Class added: MagnitudeOverride

class MetaApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Class added: MetaApiChange

class MethodApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Methods added: overrideMagnitude, isFunctionChange

class MethodParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: overrideMagnitude

class OverrideSelection (lib/config/magnitude_override.dart)

• ❇️ Class added: OverrideSelection

class ParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: overrideMagnitude

class PropertyApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Method added: overrideMagnitude

function applyMagnitudeOverrides (lib/doc_comparator/apply_overrides.dart)

• ❇️ Function added: applyMagnitudeOverrides

👀 Patch changes

class ApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Property added: _overriddenMagnitude

class ApiChangeFormatter (lib/doc_comparator/api_change_formatter.dart)

• ❌ Methods removed: _getOperationDescription, _formatTypeChange, _getComponentTypeLabel

class ComponentApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: _overriddenMagnitude, _allowedOperations

class ConstructorApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: _overriddenMagnitude, _disallowedConstructorOperations

class ConstructorParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Property added: _overriddenMagnitude

class DocVisitor (lib/doc_generator/doc_visitor.dart)

• ❇️ Method added: _getSuperClasses

class MethodApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: _overriddenMagnitude, _allowedOperations

class MethodParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Property added: _overriddenMagnitude

class ParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: _overriddenMagnitude, _allowedParameterOperations

class PropertyApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: _overriddenMagnitude, _allowedOperations

class _SelectionContext (lib/doc_comparator/apply_overrides.dart)

• ❇️ Class added: _SelectionContext

function _createContext (lib/doc_comparator/apply_overrides.dart)

• ❇️ Function added: _createContext

function _getComponentKind (lib/doc_comparator/apply_overrides.dart)

• ❇️ Function added: _getComponentKind

function _matches (lib/doc_comparator/apply_overrides.dart)

• ❇️ Function added: _matches

function _matchesSelection (lib/doc_comparator/apply_overrides.dart)

• ❇️ Function added: _matchesSelection

4.0.0

Released on: 1/12/2026, changelog automatically generated.

Bug Fixes

• filter out abstract methods in non-abstract classes during method collection (a4764ae)

Features

• Semantic Type Analysis, Modifier Support, Pubspec Support, Comparator Refactor (50d7a2e)
• add modifier change detection and enhance changelog formatting (4db3dd8)
• implement semantic type comparison for accurate breaking change detection (3da35cb)
• enhance support for parameter reordering detection and update related tests (528206a)
• add SDK constraint comparison and update related tests (c6f70cf)
• add package metadata support and pubspec.yaml analysis (61a3ea4)
• add support for type parameter changes in API documentation (317e646)

API Changes

💣 Breaking changes

class DocMethod (lib/models/doc_items.dart)

• 🔄 Param type changed in default constructor: returnType (String → DocType)
• 🔄 Property type changed: returnType

class DocParameter (lib/models/doc_items.dart)

• 🔄 Param type changed in default constructor: type (String → DocType)
• 🔄 Property type changed: type

class DocProperty (lib/models/doc_items.dart)

• 🔄 Param type changed in default constructor: type (String → DocType)
• 🔄 Property type changed: type

class MethodApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in default constructor: newType (String? → DocType?)
• 🔄 Property type changed: newType

function generateDocs (lib/doc_generator/doc_generator.dart)

• 🔄 Function type changed: generateDocs (Future<List<DocComponent>> → Future<PackageApi>)

function getRef (lib/doc_comparator/get_ref.dart)

• 🔄 Function type changed: getRef (Future<List<DocComponent>> → Future<PackageApi>)

function parseDocComponentsFile (lib/doc_comparator/parse_doc_file.dart)

• ❌ Function removed: parseDocComponentsFile

✨ Minor changes

class AndroidPlatformConstraints (lib/models/package_info.dart)

• ❇️ Class added: AndroidPlatformConstraints

enum ApiChangeOperation (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: reordered, dependencyAdded, dependencyRemoved, dependencyChanged, platformConstraintChanged, typeParametersChanged, featureAdded, featureRemoved

enum ApiChangeTarget (lib/doc_comparator/api_change_formatter.dart)

• ❇️ Enum added: ApiChangeTarget

class ConstructorApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: changedValue (named, optional)

class ConstructorParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: newType (named, optional)
• ❇️ Property added: newType

class DocComponent (lib/models/doc_items.dart)

• ❇️ Param added in default constructor: typeParameters (named, optional, default: const [])
• ❇️ Constructor added: metadata
• ❇️ Properties added: typeParameters, genericName

enum DocComponentType (lib/models/doc_items.dart)

• ❇️ Properties added: dependencyType, platformConstraintType

class DocMethod (lib/models/doc_items.dart)

• ❇️ Param added in default constructor: typeParameters (named, optional, default: const [])
• ❇️ Property added: typeParameters

class DocType (lib/models/doc_type.dart)

• ❇️ Class added: DocType

class IOSPlatformConstraints (lib/models/package_info.dart)

• ❇️ Class added: IOSPlatformConstraints

extension MetadataComparator (lib/doc_comparator/comparators/metadata_comparator.dart)

• ❇️ Extension added: MetadataComparator

class MethodApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: changedValue (named, optional)

class MethodParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: newType (named, optional)
• ❇️ Property added: newType

class PackageApi (lib/models/package_info.dart)

• ❇️ Class added: PackageApi

class PackageDependency (lib/models/package_info.dart)

• ❇️ Class added: PackageDependency

class PackageMetadata (lib/models/package_info.dart)

• ❇️ Class added: PackageMetadata

class ParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: newType (named, optional)
• ❇️ Property added: newType

class PropertyApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: changedValue (named, optional)

class PubspecAnalyzer (lib/doc_generator/pubspec_analyzer.dart)

• ❇️ Class added: PubspecAnalyzer

function compareAnnotations (lib/doc_comparator/comparators/comparator_helpers.dart)

• ❇️ Function added: compareAnnotations

function compareFeatures (lib/doc_comparator/comparators/comparator_helpers.dart)

• ❇️ Function added: compareFeatures

function compareLists (lib/doc_comparator/comparators/comparator_helpers.dart)

• ❇️ Function added: compareLists

function parsePackageApiFile (lib/doc_comparator/parse_doc_file.dart)

• ❇️ Function added: parsePackageApiFile

👀 Patch changes

class ApiChangeFormatter (lib/doc_comparator/api_change_formatter.dart)

• 🔄 Method type changed: _groupByChangeCategory (Map<int, List<ApiChange>> → Map<String, List<ApiChange>>)
• ❌ Method removed: _getOperationText
• ❇️ Methods added: _getOperationDescription, _formatTypeChange

class DocVisitor (lib/doc_generator/doc_visitor.dart)

• ❇️ Methods added: _getTypeParameters, _getDocType

function _$AndroidPlatformConstraintsFromJson (lib/models/package_info.dart)

• ❇️ Function added: _$AndroidPlatformConstraintsFromJson

function _$AndroidPlatformConstraintsToJson (lib/models/package_info.dart)

• ❇️ Function added: _$AndroidPlatformConstraintsToJson

function _$DocTypeFromJson (lib/models/doc_type.dart)

• ❇️ Function added: _$DocTypeFromJson

function _$DocTypeToJson (lib/models/doc_type.dart)

• ❇️ Function added: _$DocTypeToJson

function _$IOSPlatformConstraintsFromJson (lib/models/package_info.dart)

• ❇️ Function added: _$IOSPlatformConstraintsFromJson

function _$IOSPlatformConstraintsToJson (lib/models/package_info.dart)

• ❇️ Function added: _$IOSPlatformConstraintsToJson

function _$PackageApiFromJson (lib/models/package_info.dart)

• ❇️ Function added: _$PackageApiFromJson

function _$PackageApiToJson (lib/models/package_info.dart)

• ❇️ Function added: _$PackageApiToJson

function _$PackageDependencyFromJson (lib/models/package_info.dart)

• ❇️ Function added: _$PackageDependencyFromJson

function _$PackageDependencyToJson (lib/models/package_info.dart)

• ❇️ Function added: _$PackageDependencyToJson

function _$PackageMetadataFromJson (lib/models/package_info.dart)

• ❇️ Function added: _$PackageMetadataFromJson

function _$PackageMetadataToJson (lib/models/package_info.dart)

• ❇️ Function added: _$PackageMetadataToJson

function _compareParameters (lib/doc_comparator/comparators/member_comparator.dart)

• ❇️ Function added: _compareParameters

3.0.0

Released on: 1/7/2026, changelog automatically generated.

Features

• add configurable tag prefix for version command (#14) (fa6fbdc)

API Changes

💣 Breaking changes

function calculateNextVersion (lib/version/calculate_next_version.dart)

• ❇️ Param added in function calculateNextVersion: tagPrefix (positional, required)

function version (lib/version/version.dart)

• ❇️ Param added in function version: tagPrefix (named, required)

✨ Minor changes

class GitUtils (lib/doc_generator/git_utils.dart)

• ❇️ Param added in method getVersions: tagPrefix (named, optional, default: 'v')
• ❇️ Param added in method getPreviousRef: tagPrefix (named, optional, default: 'v')

class VersionCommand (lib/version/version_command.dart)

• ❇️ Property added: tagPrefix

2.1.0

Released on: 12/17/2025, changelog automatically generated.

Bug Fixes

• disable commit flag in PR workflow (f4676e8)
• correctly extract commits in changelog generation (c15f23e)

Features

• support enums, extensions, mixins, typedefs, superclasses and annotations (e2f7226)
• enhance changelog generation with compare URLs (b317b55)
• enhance API change detection with new operations for superclass, interfaces, and mixins (e151ce9)
• add base URL option for changelog and API change formatting (7c38812)
• add support for annotation addition and removal in API changes (50f71a3)
• add support for mixins, extensions, typedefs and enums (45c9e96)

API Changes

✨ Minor changes

class ApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: annotation, changedValue

class ApiChangeFormatter (lib/doc_comparator/api_change_formatter.dart)

• ❇️ Param added in default constructor: fileUrlBuilder (named, optional)
• ❇️ Property added: fileUrlBuilder

enum ApiChangeOperation (lib/doc_comparator/api_change.dart)

• ❇️ Properties added: annotationAdded, annotationRemoved, superClassChanged, interfaceAdded, interfaceRemoved, mixinAdded, mixinRemoved

class ChangelogGenerator (lib/changelog_generator/changelog_generator.dart)

• ❇️ Params added in default constructor: baseRef (named, optional), newRef (named, optional)
• ❇️ Properties added: baseRef, newRef

class ComponentApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Params added in default constructor: annotation (named, optional), changedValue (named, optional)
• ❇️ Properties added: annotation, changedValue

class ConstructorApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: annotation (named, optional)
• ❇️ Properties added: annotation, changedValue

class ConstructorParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: annotation (named, optional)
• ❇️ Properties added: annotation, changedValue

class DocComparatorCommand (lib/doc_comparator/doc_comparator_command.dart)

• ❇️ Property added: baseUrl

class DocComponent (lib/models/doc_items.dart)

• ❇️ Params added in default constructor: aliasedType (named, optional), annotations (named, optional, default: const []), superClass (named, optional), interfaces (named, optional, default: const []), mixins (named, optional, default: const [])
• ❇️ Properties added: aliasedType, annotations, superClass, interfaces, mixins

enum DocComponentType (lib/models/doc_items.dart)

• ❇️ Properties added: mixinType, enumType, typedefType, extensionType

class DocConstructor (lib/models/doc_items.dart)

• ❇️ Param added in default constructor: annotations (named, optional, default: const [])
• ❇️ Property added: annotations

class DocMethod (lib/models/doc_items.dart)

• ❇️ Param added in default constructor: annotations (named, optional, default: const [])
• ❇️ Property added: annotations

class DocParameter (lib/models/doc_items.dart)

• ❇️ Param added in default constructor: annotations (named, optional, default: const [])
• ❇️ Property added: annotations

class DocProperty (lib/models/doc_items.dart)

• ❇️ Param added in default constructor: annotations (named, optional, default: const [])
• ❇️ Property added: annotations

class DocVisitor (lib/doc_generator/doc_visitor.dart)

• ❇️ Class added: DocVisitor

class GitUtils (lib/doc_generator/git_utils.dart)

• ❇️ Methods added: getCurrentCommitHash, getRemoteUrl, buildCompareUrl, getCommits, getCommitsSinceLastTag

class MethodApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: annotation (named, optional)
• ❇️ Properties added: annotation, changedValue

class MethodParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: annotation (named, optional)
• ❇️ Properties added: annotation, changedValue

class ParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: annotation (named, optional)
• ❇️ Properties added: annotation, changedValue

class PropertyApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: annotation (named, optional)
• ❇️ Properties added: annotation, changedValue

👀 Patch changes

class ApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Params added in private constructor _: annotation (named, optional), changedValue (named, optional)

class ApiChangeFormatter (lib/doc_comparator/api_change_formatter.dart)

• ❇️ Method added: _getComponentTypeLabel

class ChangelogGenerator (lib/changelog_generator/changelog_generator.dart)

• ❌ Methods removed: _parseCommitLog, _getPackageVersion
• ❇️ Method added: _getPubspecInfo

2.0.0

Released on: 12/11/2025, changelog automatically generated.

Bug Fixes

• git: stage new files before committing version bump (451dcb1)

Features

• enhance API change detection to include top-level functions (bd902f3)
• enhance API change detection with method parameter comparison logic (2fa9470)
• add MethodApiChange class and comparison logic for method changes (f5f7254)
• add CacheCommand to manage/clear cache (547327a)

API Changes

💣 Breaking changes

ConstructorParameterApiChange (lib/doc_comparator/api_change.dart)

• ❌ Property removed: parameter
• ❌ Method removed: getMagnitude

DocComponent (lib/models/doc_items.dart)

• 🔄 Param type changed in default constructor: methods (named, required)
• 🔄 Property type changed: methods

✨ Minor changes

Cache (lib/doc_generator/cache.dart)

• ❇️ Method added: getCacheDir

CacheCommand (lib/cache/cache_command.dart)

• ❇️ Class added: CacheCommand

ConstructorParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Param added in default constructor: oldName (named, optional)

DocComponent (lib/models/doc_items.dart)

• ❇️ Param added in default constructor: type (named, optional, default: DocComponentType.classType)
• ❇️ Property added: type

DocMethod (lib/models/doc_items.dart)

• ❇️ Class added: DocMethod

DocParameter (lib/models/doc_items.dart)

• ❇️ Param added in default constructor: defaultValue (named, optional)
• ❇️ Property added: defaultValue

MethodApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Class added: MethodApiChange

MethodParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Class added: MethodParameterApiChange

ParameterApiChange (lib/doc_comparator/api_change.dart)

• ❇️ Class added: ParameterApiChange

👀 Patch changes

_$DocMethodFromJson (lib/models/doc_items.dart)

• ❇️ Function added: _$DocMethodFromJson

_$DocMethodToJson (lib/models/doc_items.dart)

• ❇️ Function added: _$DocMethodToJson

1.0.1

Released on: 12/8/2025, changelog automatically generated.

Bug Fixes

• add annotation message to git tag command so that the --follow-tags param from the workflow succeeds (e23fb1d)
• properly push version badge and tag from workflow (ae2ffd9)
• properly push version badge and tag from workflow (452c9c2)
• string escaping comment, honor analysis_options.yaml excludes and use mason_logger (#1) (99079e9)
• git: stage new files before committing version bump (451dcb1)
• remove examples/ dir in order to satisfy pub.dev package requirements (da32b65)

1.0.0

Released on: 12/8/2025, changelog automatically generated.

Bug Fixes

• add annotation message to git tag command so that the --follow-tags param from the workflow succeeds (e23fb1d)
• properly push version badge and tag from workflow (ae2ffd9)
• properly push version badge and tag from workflow (452c9c2)
• string escaping comment, honor analysis_options.yaml excludes and use mason_logger (#1) (99079e9)
• update constructor reference in API change tracking (4028006)

Features

• add JSON serialization methods for documentation types and move library types to a new file (e04c07c)
• add Git ref inputs for base documentation context (fd47bb5)
• add customizable PR comment message template and prepare content dynamically (6ed85f0)
• initial commit of M-Trust API Guard (ed5f21d)
• remove examples/ dir in order to satisfy pub.dev package requirements (da32b65)

API Changes

💣 Breaking changes

ApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Property type changed: component

ApiChangeFormatter (lib/doc_comparator/api_change_formatter.dart)

• ❌ Property removed: showUpToMagnitude

ComponentApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in constructor new: component

ConstructorApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in constructor new: component

ConstructorParameterApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in constructor new: component

PropertyApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in constructor new: component

✨ Minor changes

ApiChangeFormatter (lib/doc_comparator/api_change_formatter.dart)

• ❌ Param removed in constructor new: showUpToMagnitude
• ❇️ Params added in constructor new: markdownHeaderLevel, magnitudes
• ❇️ Properties added: magnitudes, markdownHeaderLevel, hasRelevantChanges, highestMagnitudeText

ApiGuardConfig (lib/config/config.dart)

• ❇️ Class added: ApiGuardConfig

BadgeGeneratorCommand (lib/badges/badge_generator_command.dart)

• ❇️ Class added: BadgeGeneratorCommand

Cache (lib/doc_generator/cache.dart)

• ❇️ Class added: Cache

ChangelogGenerator (lib/changelog_generator/changelog_generator.dart)

• ❇️ Class added: ChangelogGenerator

ChangelogGeneratorCommand (lib/changelog_generator/changelog_generator_command.dart)

• ❇️ Class added: ChangelogGeneratorCommand

DocComparatorCommand (lib/doc_comparator/doc_comparator.dart)

• ❇️ Properties added: out, magnitudes

DocComponent (lib/doc_items.dart)

• ❇️ Param added in constructor new: filePath
• ❇️ Property added: filePath

DocGeneratorCommand (lib/doc_generator/doc_generator.dart)

• ❇️ Properties added: argParser, out, ref, help

GitException (lib/doc_generator/git_utils.dart)

• ❇️ Class added: GitException

GitUtils (lib/doc_generator/git_utils.dart)

• ❇️ Class added: GitUtils

PubspecUtils (lib/pubspec_utils.dart)

• ❇️ Class added: PubspecUtils

VersionCommand (lib/version/version_command.dart)

• ❇️ Class added: VersionCommand

VersionResult (lib/version/version.dart)

• ❇️ Class added: VersionResult

👀 Patch changes

ApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in private constructor _: component

1.0.2

Released on: 12/8/2025, changelog automatically generated.

Bug Fixes

• add annotation message to git tag command so that the --follow-tags param from the workflow succeeds (e23fb1d)
• properly push version badge and tag from workflow (ae2ffd9)
• properly push version badge and tag from workflow (452c9c2)

1.0.1

Released on: 12/8/2025, changelog automatically generated.

Bug Fixes

• properly push version badge and tag from workflow (ae2ffd9)
• properly push version badge and tag from workflow (452c9c2)
• string escaping comment, honor analysis_options.yaml excludes and use mason_logger (#1) (99079e9)

1.0.0

Released on: 11/4/2025, changelog automatically generated.

Bug Fixes

• string escaping comment, honor analysis_options.yaml excludes and use mason_logger (#1) (99079e9)
• update constructor reference in API change tracking (4028006)

Features

• add JSON serialization methods for documentation types and move library types to a new file (e04c07c)
• add Git ref inputs for base documentation context (fd47bb5)
• add customizable PR comment message template and prepare content dynamically (6ed85f0)
• initial commit of M-Trust API Guard (ed5f21d)

API Changes

💣 Breaking changes

ApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Property type changed: component

ApiChangeFormatter (lib/doc_comparator/api_change_formatter.dart)

• ❌ Property removed: showUpToMagnitude

ComponentApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in constructor new: component

ConstructorApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in constructor new: component

ConstructorParameterApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in constructor new: component

PropertyApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in constructor new: component

✨ Minor changes

ApiChangeFormatter (lib/doc_comparator/api_change_formatter.dart)

• ❌ Param removed in constructor new: showUpToMagnitude
• ❇️ Params added in constructor new: markdownHeaderLevel, magnitudes
• ❇️ Properties added: magnitudes, markdownHeaderLevel, hasRelevantChanges, highestMagnitudeText

ApiGuardConfig (lib/config/config.dart)

• ❇️ Class added: ApiGuardConfig

BadgeGeneratorCommand (lib/badges/badge_generator_command.dart)

• ❇️ Class added: BadgeGeneratorCommand

Cache (lib/doc_generator/cache.dart)

• ❇️ Class added: Cache

ChangelogGenerator (lib/changelog_generator/changelog_generator.dart)

• ❇️ Class added: ChangelogGenerator

ChangelogGeneratorCommand (lib/changelog_generator/changelog_generator_command.dart)

• ❇️ Class added: ChangelogGeneratorCommand

DocComparatorCommand (lib/doc_comparator/doc_comparator.dart)

• ❇️ Properties added: out, magnitudes

DocComponent (lib/doc_items.dart)

• ❇️ Param added in constructor new: filePath
• ❇️ Property added: filePath

DocGeneratorCommand (lib/doc_generator/doc_generator.dart)

• ❇️ Properties added: argParser, out, ref, help

GitException (lib/doc_generator/git_utils.dart)

• ❇️ Class added: GitException

GitUtils (lib/doc_generator/git_utils.dart)

• ❇️ Class added: GitUtils

PubspecUtils (lib/pubspec_utils.dart)

• ❇️ Class added: PubspecUtils

VersionCommand (lib/version/version_command.dart)

• ❇️ Class added: VersionCommand

VersionResult (lib/version/version.dart)

• ❇️ Class added: VersionResult

👀 Patch changes

ApiChange (lib/doc_comparator/api_change.dart)

• 🔄 Param type changed in private constructor _: component

0.0.1

• First release