changelog-buildbreaker:check

Full name:

com.github.peterwippermann.maven:changelog-buildbreaker-maven-plugin:1.0.0:check

Description:

Checks the project's changelog file and breaks the build, if the changelog contains changes tagged as "unreleased".

Typically to be used in the preparation phase of a release to ensure the changelog is in-sync with the release.

Attributes:

  • Requires a Maven project to be executed.

Optional Parameters

Name Type Since Description
changelogFile File - Location of the changelog file.
Default value is: ./CHANGELOG.md.
User property is: changelogFile.
encoding String - Encoding of the changelog file.

The general build property project.build.sourceEncoding is used as a fallback. Will be defaulted to UTF-8 otherwise.


Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
unreleasedChangesPattern String - RegEx-Pattern for the "Unreleased" section.

The default pattern will match the format proposed by keepachangelog.com


Default value is: (?:^|\R)(?<section>##\h*\[Unreleased\]\h*)\R(?:\h*\R)*(?<content>\h*(?!##\h*\[)\p{Graph}+.*)(?:$|\R).
User property is: unreleasedChangesPattern.

Parameter Details

changelogFile:

Location of the changelog file.
  • Type: java.io.File
  • Required: No
  • User Property: changelogFile
  • Default: ./CHANGELOG.md

encoding:

Encoding of the changelog file.

The general build property project.build.sourceEncoding is used as a fallback. Will be defaulted to UTF-8 otherwise.

  • Type: java.lang.String
  • Required: No
  • User Property: encoding
  • Default: ${project.build.sourceEncoding}

unreleasedChangesPattern:

RegEx-Pattern for the "Unreleased" section.

The default pattern will match the format proposed by keepachangelog.com

  • Type: java.lang.String
  • Required: No
  • User Property: unreleasedChangesPattern
  • Default: (?:^|\R)(?<section>##\h*\[Unreleased\]\h*)\R(?:\h*\R)*(?<content>\h*(?!##\h*\[)\p{Graph}+.*)(?:$|\R)