From adb20bc4da63d4cec663ca68648db0f808e3d181 Mon Sep 17 00:00:00 2001 From: Kai Moritz Date: Fri, 18 Oct 2013 01:52:27 +0200 Subject: [PATCH] Added missing documentation for skip-configuration --- src/site/apt/skip.apt | 55 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 src/site/apt/skip.apt diff --git a/src/site/apt/skip.apt b/src/site/apt/skip.apt new file mode 100644 index 00000000..676a7def --- /dev/null +++ b/src/site/apt/skip.apt @@ -0,0 +1,55 @@ + --- + To Skip or not to skip: that is the question + --- + Kai Moritz + --- + + In most use-cases, the hibernate4-maven-plugin is used to create a + test-database automatically. In this use-cases, it is very likely, that it + will result in mistakes/errors, if the goal is executed, when the tests + are skipped. + For example, one might manually overwrite the database-url with the url of + the production-database, in order to run other tests, like starting a + local webserver with the + {{{http://wiki.eclipse.org/Jetty/Feature/Jetty_Maven_Plugin}jetty-maven-plugin}}. + If the export-goal would be executed in such a scenario, it might erase the + hole production-database, which is not very desireable. + + Because of this, the configuration-parameter <<>> defaults to the value + of the proptery <<>>. This way, the execution of the + hibernate4-maven-plugin is skipped automatically, when the tests are + skipped. Think of it as a build-in security-belt. + + If you do not like that, because you need the plugin to always execute the + export-goal, even if the tests are skipped you can configure that explicitly, + by setting the configuration-parameter <<>> to false: + +------------ + + de.juplo + hibernate4-maven-plugin + ... + + false + + +------------ + + Or, if you want the export-goal to be executed by default and to be skipped + if you say so, you can bind the value of the configuration-parameter + <<>> to a custom property. For example: + +------------ + + de.juplo + hibernate4-maven-plugin + ... + + ${foo.bar} + + +------------ + + This way, the export-goal would be skipped, if you set the property + <<>> to <<>>. For example, if you specify <<<-Dfoo.bar=true>>> + on the command-line. -- 2.20.1