gradle-changelog-plugin

Added

• Insert blank lines around headings and lists to satisfy Markdown syntax guidelines #190

Changed

• Rename the getChangelog CLI option from --version=.. to --project-version=.. #188

Fixed

• Changelog render is inconsistent between different line separators #182

Changed

• Use GITHUB_OUTPUT environment file instead of deprecated ::set-output command in GitHub Actions
• Deprecate itemPrefix and lineSeparator properties in the org.jetbrains.changelog.Changelog.Item constructor #181

Fixed

• Wrong markdown render of changelog that use CRLF or CR line separator #176
• Changelog.Item.plus copies original item without restoring all original data #179

Added

• versionPrefix to allow setting the version prefix to compare tags #139
• --no-empty-sections flag to getChangelog task #167

Fixed

• No-longer discard all but the last paragraph in list items #133 #147

Added

• Allow for customizing the changelog introduction
• Make changelog.instance property public
• Introduce changelog summary and changelog property #127
• Introduce changelog preTitle and title changelog properties
• Ensure patched changelog ends with a newline #126
• Added the changelog.lineSeparator property to allow for customizing the line separator used in the changelog #104
• Added the --version=... CLI parameter for the getChangelog task #83
• Throw an exception when initializeChangelog task works on non-empty file #82
• Remove empty sections from the changelog while patching #28
• Added the changelog.combinePreReleases property to allow for combining pre-releases into a single section #50

Changed

• Upgrade minimal required Gradle version to 6.8
• Make withHeader property of the Changelog.Item object true by default
• Updated the HeaderParseException message #84
• Use "[${project.version}] - ${date()}" as the default value for the changelog.header property #18

Deprecated

• Changelog.Item.toText() replaced with Changelog.renderItem(Chagnelog.Item)
• Changelog.Item.toHTML() replaced with Changelog.renderItem(Chagnelog.Item, Changelog.OutputType.HTML)
• Changelog.Item.toPlainText() replaced with Changelog.renderItem(Chagnelog.Item, Changelog.OutputType.PLAIN_TEXT)

Changed

• Use the actual version numbers as keys for extension.items instead of raw header value

Added

• PatchChangelogTask: --release-note CLI option to add a custom release note to the latest changelog entry

Added

• getOrNull extension method
• Configuration Cache support

Added

• Task Configuration Avoidance
• Lazy Properties

Fixed

• InitializeChangelogTask issue for no groups present

Changed

• Remove shadowJar

Fixed

• Don't create groups for the new Unreleased section if empty array is provided

Changed

• Require changelog.version to be provided explicitly

Fixed

• unspecified version when patching the changelog

Changed

• Require changelog.version to be provided explicitly

Fixed

• unspecified version when patching the changelog

Fixed

• Provide project.version to the extension using conventions

Added

• Support for the Configuration cache

Changed

• header closure has the delegate explicitly set to the extension's context
• Upgrade Gradle Wrapper to 6.6
• Upgrade org.jetbrains.kotlin.jvm to 1.4.21
• Upgrade io.gitlab.arturbosch.detekt to 1.15.0
• Upgrade com.github.johnrengelman.shadow to 6.1.0

Changed

• Smart processing of headerParserRegex property

Changed

• Renamed hasVersion method to has
• Better error handling in patchChangelog task

Added

• headerParserRegex extension property for setting custom regex used to extract version from the header string

Changed

• Project dependencies upgrade
• Apply ktlint and detekt rules to the code

Added

• header extension property for setting new header text
• date helper method
• Helper Methods section in README

Removed

• headerFormat and headerArguments in favor of header property

Added

• initializeChangelog task for creating new changelog file
• getAll extensions method for fetching all changelog items
• groups extensions property for defining the groups created with the Unreleased section
• ktlint integration

Changed

• Moved tasks to the changelog group

Added

• patchEmpty extension property
• Better error handling for the header parser
• GitHub Actions integration with itself

Fixed

• Possibility to write date besides versions #5

Changed

• unreleasedTerm default value set from Unreleased to [Unreleased]