Package io.quarkus.maven

Class TrackConfigChangesMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

io.quarkus.maven.QuarkusBootstrapMojo

io.quarkus.maven.TrackConfigChangesMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="track-config-changes",
      defaultPhase=PROCESS_RESOURCES,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      threadSafe=true)
public class TrackConfigChangesMojo
extends QuarkusBootstrapMojo

Maven goal that is executed before the BuildMojo. The goal looks for a file that contains build time configuration options read during the previous build. If that file exists, the goal will check whether the configuration options used during the previous build have changed in the current configuration and will persist their current values to another file, so that both configuration files could be compared by tools caching build goal outcomes to check whether the previous outcome of the BuildMojo needs to be rebuilt.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) File	dependenciesFile	Dependency dump file
(package private) boolean	dumpCurrentWhenRecordedUnavailable	Whether to dump the current build configuration in case the configuration from the previous build isn't found
(package private) boolean	dumpDependencies	Whether to dump Quarkus application dependencies along with their checksums
(package private) String	mode
(package private) File	outputDirectory
(package private) File	outputFile
(package private) File	recordedBuildConfigDirectory
(package private) String	recordedBuildConfigFile
(package private) boolean	skip	Skip the execution of this mojo

Fields inherited from class io.quarkus.maven.QuarkusBootstrapMojo

BOOTSTRAP_ID_PARAM, bootstrapId, bootstrapProvider, CLOSE_BOOTSTRAPPED_APP_PARAM, closeBootstrappedApp, MODE_PARAM, mojoExecution, NATIVE_PROFILE_NAME, RELOAD_POMS_PARAM, reloadPoms

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
TrackConfigChangesMojo()

Method Summary

Modifier and Type	Method	Description
protected boolean	beforeExecute()	This callback allows to evaluate whether this mojo should be executed, skipped or fail.
protected void	doExecute()	Main mojo execution code

Methods inherited from class io.quarkus.maven.QuarkusBootstrapMojo

appArtifactCoords, baseDir, bootstrapApplication, bootstrapApplication, bootstrapApplication, bootstrapId, buildDir, closeApplication, execute, finalName, forcedDependencies, getBuildSystemProperties, getWorkspaceId, ignoredEntries, isNativeProfileEnabled, manifestEntries, manifestSections, mavenProject, mavenSession, projectId, properties, remoteRepositories, remoteRepositoryManager, repositorySystem, repositorySystemSession, setLog, setNativeEnabledIfNativeProfileEnabled

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

skip

@Parameter(defaultValue="false",
           property="quarkus.track-config-changes.skip")
boolean skip

Skip the execution of this mojo

mode

@Parameter(property="launchMode")
String mode

outputDirectory

@Parameter(property="quarkus.track-config-changes.outputDirectory",
           defaultValue="${project.build.directory}")
File outputDirectory

outputFile

@Parameter(property="quarkus.track-config-changes.outputFile",
           required=false)
File outputFile

recordedBuildConfigDirectory

@Parameter(property="quarkus.recorded-build-config.directory",
           defaultValue="${basedir}/.quarkus")
File recordedBuildConfigDirectory

recordedBuildConfigFile

@Parameter(property="quarkus.recorded-build-config.file",
           required=false)
String recordedBuildConfigFile

dumpCurrentWhenRecordedUnavailable

@Parameter(defaultValue="false",
           property="quarkus.track-config-changes.dump-current-when-recorded-unavailable")
boolean dumpCurrentWhenRecordedUnavailable

Whether to dump the current build configuration in case the configuration from the previous build isn't found

dumpDependencies

@Parameter(defaultValue="true",
           property="quarkus.track-config-changes.dump-dependencies")
boolean dumpDependencies

Whether to dump Quarkus application dependencies along with their checksums

dependenciesFile

@Parameter(property="quarkus.track-config-changes.dependencies-file")
File dependenciesFile

Dependency dump file

Constructor Details

TrackConfigChangesMojo

public TrackConfigChangesMojo()

Method Details

beforeExecute

protected boolean beforeExecute()
                         throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Description copied from class: QuarkusBootstrapMojo

This callback allows to evaluate whether this mojo should be executed, skipped or fail.

Specified by:

beforeExecute in class QuarkusBootstrapMojo

Returns:

false if the execution of the mojo should be skipped, true if the mojo should be executed

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of a failure

org.apache.maven.plugin.MojoFailureException - in case of a failure

doExecute

protected void doExecute()
                  throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Description copied from class: QuarkusBootstrapMojo

Main mojo execution code

Specified by:

doExecute in class QuarkusBootstrapMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - in case of a failure

org.apache.maven.plugin.MojoFailureException - in case of a failure