Repository: maven-archetype Updated Branches: refs/heads/master f32d67fd9 -> 480204259
Add documentation Add some documentation for the archetype test when create from project, and also for the post-generation script. Project: http://git-wip-us.apache.org/repos/asf/maven-archetype/repo Commit: http://git-wip-us.apache.org/repos/asf/maven-archetype/commit/48020425 Tree: http://git-wip-us.apache.org/repos/asf/maven-archetype/tree/48020425 Diff: http://git-wip-us.apache.org/repos/asf/maven-archetype/diff/48020425 Branch: refs/heads/master Commit: 480204259a77f21738cbc2d70d9f0dab6c63cc06 Parents: f32d67f Author: Petar Tahchiev <paranoia...@gmail.com> Authored: Sat Jan 16 23:44:28 2016 +0200 Committer: Petar Tahchiev <paranoia...@gmail.com> Committed: Sat Jan 16 23:44:28 2016 +0200 ---------------------------------------------------------------------- .../src/site/apt/advanced-usage.apt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/maven-archetype/blob/48020425/maven-archetype-plugin/src/site/apt/advanced-usage.apt ---------------------------------------------------------------------- diff --git a/maven-archetype-plugin/src/site/apt/advanced-usage.apt b/maven-archetype-plugin/src/site/apt/advanced-usage.apt index c28f6e1..fa3365f 100644 --- a/maven-archetype-plugin/src/site/apt/advanced-usage.apt +++ b/maven-archetype-plugin/src/site/apt/advanced-usage.apt @@ -138,6 +138,13 @@ Choose archetype: Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): 1: +--- +Testing + + The user can provide archetype test projects by placing them in <<<src/it/projects>>> + folder of their project. Upon creating archetype from the existing project all the test + projects will be executed to verify the archetype created by this project is good. + {{{./integration-test-mojo.html}Read more}} about testing maven archetype. + Configuration The <<<create-from-project>>> goal enable the user to provide some sensible @@ -149,3 +156,13 @@ Configuration When used, the property file takes precedence over the system properties. It is also the only way to define additional properties in the archetype. + +Post-generation script + + If the user wants to customize the generated project even further, a groovy script + named <<<archetype-post-generate.groovy>>> can be added in <<<src/main/resources/META-INF/>>>. + This script will end up in the generated archetype's <<<META-INF>>> folder and will be executed + upon creating a project from this archetype. This groovy script has access to the + <<<ArchetypeGenerationRequest>>> object, as well as all the <<<System.getProperties()>>> and all + the archetype generation properties the user has specified. +