Class UpdateVersionTextMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

    @Mojo(name="update-version-text",
          requiresProject=true,
          defaultPhase=PACKAGE)
    public class UpdateVersionTextMojo
    extends AbstractVersionMojo
    Update the active version entry in the VERSION.txt file from information present in the git logs.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private boolean attachArtifact
      Allow the plugin to attach the generated VERSION.txt file to the project
      private boolean copyGenerated
      Allow the plugin to replace the input VERSION.txt file
      private boolean refreshTags
      Allow the plugin to issue a 'git fetch --tags' to update the local tags from.
      private boolean sortExisting
      Allow the existing issues to be sorted alphabetically.
      private boolean updateDate
      Allow the plugin to update the release date for an issue (if none is provided)
      private java.lang.String version
      The maven project version.
      private java.lang.String versionTagKey
      The version key to use when looking up a git tag ref.
      private java.lang.String versionTextKey
      The version key to use in the VERSION.txt file.
      private java.io.File versionTextOuputFile
      The generated VERSION.txt file.
      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE
    • Field Detail

      • version

        @Parameter(property="version.section",
                   defaultValue="${project.version}",
                   required=true)
        private java.lang.String version
        The maven project version.
      • versionTextKey

        @Parameter(property="version.text.key",
                   defaultValue="jetty-VERSION",
                   required=true)
        private java.lang.String versionTextKey
        The version key to use in the VERSION.txt file.
      • versionTagKey

        @Parameter(property="version.tag.key",
                   defaultValue="jetty-VERSION",
                   required=true)
        private java.lang.String versionTagKey
        The version key to use when looking up a git tag ref.
      • sortExisting

        @Parameter(property="version.sort.existing",
                   defaultValue="false")
        private boolean sortExisting
        Allow the existing issues to be sorted alphabetically.
      • refreshTags

        @Parameter(property="version.refresh.tags",
                   defaultValue="false")
        private boolean refreshTags
        Allow the plugin to issue a 'git fetch --tags' to update the local tags from.
      • updateDate

        @Parameter(property="version.update.date",
                   defaultValue="false")
        private boolean updateDate
        Allow the plugin to update the release date for an issue (if none is provided)
      • copyGenerated

        @Parameter(property="version.copy.generated",
                   defaultValue="false")
        private boolean copyGenerated
        Allow the plugin to replace the input VERSION.txt file
      • attachArtifact

        @Parameter(property="version.attach",
                   defaultValue="false")
        private boolean attachArtifact
        Allow the plugin to attach the generated VERSION.txt file to the project
      • versionTextOuputFile

        @Parameter(property="version.text.output.file",
                   defaultValue="${project.build.directory}/VERSION.txt")
        private java.io.File versionTextOuputFile
        The generated VERSION.txt file.

    • Constructor Detail

      • UpdateVersionTextMojo

        public UpdateVersionTextMojo()
    • Method Detail

      • execute

        public void execute()
                     throws org.apache.maven.plugin.MojoExecutionException,
                            org.apache.maven.plugin.MojoFailureException
        Throws:
        org.apache.maven.plugin.MojoExecutionException
        org.apache.maven.plugin.MojoFailureException
      • generateVersion

        private void generateVersion​(VersionText versionText)
                              throws org.apache.maven.plugin.MojoFailureException,
                                     java.io.IOException
        Throws:
        org.apache.maven.plugin.MojoFailureException
        java.io.IOException