Package com.github.koraktor.mavanagaiata.mojo

Klasse ChangelogMojo

java.lang.Object
org.apache.maven.plugin.AbstractMojo
com.github.koraktor.mavanagaiata.mojo.AbstractGitMojo
com.github.koraktor.mavanagaiata.mojo.AbstractGitOutputMojo
com.github.koraktor.mavanagaiata.mojo.ChangelogMojo
Alle implementierten Schnittstellen:
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.
Seit:
0.2.0
Autor:
Sebastian Staudt

  • Felddetails

    • format

      @Parameter(property="mavanagaiata.changelog.format") protected ChangelogFormat format
      The format to use while generating the changelog
      Seit:
      0.9.0
      Siehe auch:

    • 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.

      Seit:
      0.9.0

    • linkToProject

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

    • linkToUser

      @Parameter(property="mavanagaiata.changelog.linkToUser") String linkToUser
      The user name for GitHub links
      Seit:
      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.

      Seit:
      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
      Seit:
      0.9.0

    • outputFile

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

    • skipMergeCommits

      @Parameter(property="mavanagaiata.changelog.skipMergeCommits", defaultValue="true") boolean skipMergeCommits
      Whether to skip merge commits’ messages
      Seit:
      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
      Seit:
      0.8.0

    • skipCommitsPattern

      private Pattern skipCommitsPattern

  • Konstruktordetails

    • ChangelogMojo

      public ChangelogMojo()

  • Methodendetails

    • writeOutput

      protected void writeOutput(GitRepository repository) throws MavanagaiataMojoException
      Walks through the history of the currently checked out branch of the Git repository and builds a changelog from the commits contained in that branch.
      Angegeben von:
      writeOutput in Klasse AbstractGitOutputMojo
      Parameter:
      repository - The repository the mojo is running in
      Löst aus:
      MavanagaiataMojoException - if retrieving information from the Git repository fails

    • getOutputFile

      public File getOutputFile()
      Returns the output file for the generated changelog
      Angegeben von:
      getOutputFile in Klasse AbstractGitOutputMojo
      Gibt zurück:
      The output file for the generated changelog

    • initConfiguration

      protected void initConfiguration()
      Setzt außer Kraft:
      initConfiguration in Klasse AbstractGitOutputMojo

    • setOutputFile

      public void setOutputFile(File outputFile)
      Sets the output file for the generated changelog
      Angegeben von:
      setOutputFile in Klasse AbstractGitOutputMojo
      Parameter:
      outputFile - The output file for the generated changelog