Package com.github.koraktor.mavanagaiata.mojo

Class ChangelogMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="changelog",
      defaultPhase=PROCESS_RESOURCES,
      threadSafe=true)
public class ChangelogMojo
extends AbstractGitOutputMojo
    This goal allows to generate a changelog of the currently checked out branch of the Git repository. It will use information from tags and commit messages to build a reverse chronological summary of the development. It can be configured to display the changelog or save it to a file.
    Since:
    0.2.0
    Author:
    Sebastian Staudt

    • Field Detail

      • format

        @Parameter(property="mavanagaiata.changelog.format")
protected ChangelogFormat format
        The format to use while generating the changelog
        Since:
        0.9.0
        See Also:
        formatTemplate

      • formatTemplate

        @Parameter(property="mavanagaiata.changelog.formatTemplate",
           defaultValue="DEFAULT")
ChangelogFormat.Formats formatTemplate
        The formatting template to use while generating the changelog

        This may be one of DEFAULT or MARKDOWN.

        Individual attributes may be overridden using format.

        Since:
        0.9.0

      • linkToProject

        @Parameter(property="mavanagaiata.changelog.linkToProject")
String linkToProject
        The project name for GitHub links
        Since:
        0.9.0

      • linkToUser

        @Parameter(property="mavanagaiata.changelog.linkToUser")
String linkToUser
        The user name for GitHub links
        Since:
        0.9.0

      • linkTo

        @Parameter(property="mavanagaiata.changelog.linkTo",
           defaultValue="GITHUB")
ChangelogMojo.LinkToBaseUrl linkTo
        Used to select the service to create links to

        GITHUB and GITLAB are available.

        Since:
        0.9.0

      • linkToBaseUrl

        @Parameter(property="mavanagaiata.changelog.linkToBaseUrl")
String linkToBaseUrl
        Can be used to override the pre-defined URLs from linkTo with a customized URL
        Since:
        0.9.0

      • outputFile

        @Parameter(property="mavanagaiata.changelog.outputFile")
protected File outputFile
        The file to write the changelog to
        Since:
        0.4.1

      • skipMergeCommits

        @Parameter(property="mavanagaiata.changelog.skipMergeCommits",
           defaultValue="true")
boolean skipMergeCommits
        Whether to skip merge commits’ messages
        Since:
        0.9.0

      • skipTagged

        @Parameter(property="mavanagaiata.changelog.skipTagged",
           defaultValue="false")
boolean skipTagged
        Whether to skip tagged commits' messages
        This is useful when usually tagging commits like "Version bump to X.Y.Z"

      • skipCommitsMatching

        @Parameter(property="mavanagaiata.changelog.skipCommitsMatching")
String skipCommitsMatching
        Whether to skip commits that match the given regular expression
        Since:
        0.8.0

      • skipCommitsPattern

        private Pattern skipCommitsPattern

    • Constructor Detail

      • ChangelogMojo

        public ChangelogMojo()