Class UpdateReadmeMojo

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

    @Mojo(name="update-readme",
          threadSafe=true)
    public class UpdateReadmeMojo
    extends AbstractGeneratorMojo
    Generate or updates the component/dataformat/language/eip readme.md and .adoc files in the project root directory.
    • Field Detail

      • buildDir

        @Parameter(defaultValue="${project.build.directory}")
        protected File buildDir
        The project build directory
      • componentDocDir

        @Parameter(defaultValue="${project.basedir}/src/main/docs")
        protected File componentDocDir
        The component documentation directory
      • dataformatDocDir

        @Parameter(defaultValue="${project.basedir}/src/main/docs")
        protected File dataformatDocDir
        The dataformat documentation directory
      • languageDocDir

        @Parameter(defaultValue="${project.basedir}/src/main/docs")
        protected File languageDocDir
        The language documentation directory
      • languageDocDir2

        @Parameter(defaultValue="${project.basedir}/src/main/docs/modules/languages/pages")
        protected File languageDocDir2
        The other language documentation directory
      • eipDocDir

        @Parameter(defaultValue="${project.basedir}/src/main/docs/modules/eips/pages")
        protected File eipDocDir
        The EIP documentation directory
      • failFast

        @Parameter
        protected Boolean failFast
        Whether to fail the build fast if any Warnings was detected.
      • sourceRoots

        protected List<Path> sourceRoots
    • Constructor Detail

      • UpdateReadmeMojo

        public UpdateReadmeMojo()
    • Method Detail

      • execute

        public void execute​(org.apache.maven.project.MavenProject project,
                            org.apache.maven.project.MavenProjectHelper projectHelper,
                            org.sonatype.plexus.build.incremental.BuildContext buildContext)
                     throws org.apache.maven.plugin.MojoFailureException,
                            org.apache.maven.plugin.MojoExecutionException
        Overrides:
        execute in class AbstractGeneratorMojo
        Throws:
        org.apache.maven.plugin.MojoFailureException
        org.apache.maven.plugin.MojoExecutionException
      • execute

        public void execute()
                     throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException