Templated Maven Plugin

You can copy/link automatically all your common config files of all your projects from a template directory.

License	MIT License
Categories	Maven Build Tools
GroupId	es.miyoda
ArtifactId	templated-maven-plugin
Last Version	1.1.0
Release Date	Dec 11, 2017
Type	maven-plugin
Description	Templated Maven Plugin You can copy/link automatically all your common config files of all your projects from a template directory.
Project URL	https://github.com/miyoda/templated-mvn
Source Code Management	https://github.com/miyoda/templated-mvn

Download templated-maven-plugin

Filename	Size
templated-maven-plugin-1.1.0.pom
templated-maven-plugin-1.1.0.jar	6 KB
templated-maven-plugin-1.1.0-sources.jar	1 KB
templated-maven-plugin-1.1.0-javadoc.jar	23 KB

How to add to project

Apache Maven

<plugin>
    <groupId>es.miyoda</groupId>
    <artifactId>templated-maven-plugin</artifactId>
    <version>1.1.0</version>
</plugin>

Dependencies

compile (1)

Group / Artifact	Type	Version
org.apache.maven : maven-plugin-api	jar	3.0

provided (1)

Group / Artifact	Type	Version
org.apache.maven.plugin-tools : maven-plugin-annotations	jar	3.4

Project Modules

There are no modules declared in this project.

Templated

You can copy/link automatically all your common config files of all your projects from a template directory. You can config to copy parts of files that is common in different projects. It's util for common config files/parts for all subprojects/microservices like .gitignore, copyright, etc.

Config your project

Add the dependency in you "pom.xml":

...
  <build>
    <plugins>
      <plugin>
        <groupId>es.miyoda</groupId>
        <artifactId>templated-maven-plugin</artifactId>
        <version>1.1.0</version>
      </plugin>
    </plugins>
  </build>
...

You must define in your "pom.xml" file with your templated reposiotories source configured:

...
  <build>
    <plugins>
      <plugin>
        <groupId>es.miyoda</groupId>
        <artifactId>templated-maven-plugin</artifactId>
        <version>1.1.0</version>
        <configuration>
            <sources>
							<param>../templated-example-template</param>
							<param>../templated-example-template2</param>
						</sources>
        </configuration>
      </plugin>
    </plugins>
  </build>
...

Automate the execution in any maven goal:

...
  <build>
    <plugins>
      <plugin>
        <groupId>es.miyoda</groupId>
        <artifactId>templated-maven-plugin</artifactId>
        <version>1.1.0</version>
        <executions>
          <execution>
            <phase>compile</phase>
            <goals>
              <goal>templated</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
...

Config your template repository

Copy files

All files in the templated repository was copied to your project automatically.

Copy parts

If you want to embed a part of file you can create in your templated repository a file with the name: file-name-when-you-want-embed|embed-tag.part

For example:

readme.md|copyright.part

The "content part" was replaced in your file with the position of the embed-tag indicated. You must indicate in your file where you want put the content with your embed tag. In a .md/.html file it is with:

<!-- start|embed-tag --> it was replaced <!-- end|embed-tag -->

For example:

<!-- start|copyright --> it was replaced <!-- end|copyright -->

If you want put in de start or de end of the file you don't need define the embed tag position. Simply use files with tag "start" or "end" like:

readme.md|start.part

readme.md|end.part

You can view an example of use in: https://github.com/miyoda/templated-example-usage.git

The example use the template: https://github.com/miyoda/templated-example-template.git

Versions

Version
1.1.0 Dec 11, 2017
1.0.0 Dec 11, 2017