DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones AWS Cloud
by AWS Developer Relations
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones
AWS Cloud
by AWS Developer Relations
The Latest "Software Integration: The Intersection of APIs, Microservices, and Cloud-Based Systems" Trend Report
Get the report
  1. DZone
  2. Coding
  3. Java
  4. Creating a Maven Archetype

Creating a Maven Archetype

Read this tutorial in order to learn how to create a Maven archetype from an existing project. This person uses Eclipse IDE to create the Maven project.

Anupam Gogoi user avatar by
Anupam Gogoi
·
May. 17, 18 · Tutorial
Like (5)
Save
Tweet
Share
16.98K Views

Join the DZone community and get the full member experience.

Join For Free

Introduction

Many times we need to create a Maven archetype to distribute the project template. Here in this article, I am going to describe how easy it is to create a Maven archetype from an existing project.

Create a Maven Project

First of all, let's create a very simple Maven project. I am using Eclipse IDE to create the Maven project. Here is the pom.xml file of the project:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.porua</groupId>
    <artifactId>archetype-porua</artifactId>
    <version>1.0.0</version>
    <dependencies>
        <dependency>
            <groupId>com.porua</groupId>
            <artifactId>porua-container</artifactId>
            <version>1.0.0</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <version>1.4.196</version>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.1.0</version>
                <executions>
                    <execution>
                        <id>make-fat-jar</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <descriptorRefs>
                                <descriptorRef>jar-with-dependencies</descriptorRef>
                            </descriptorRefs>
                            <finalName>${project.artifactId}-${project.version}</finalName>
                            <appendAssemblyId>false</appendAssemblyId>
                        </configuration>
                    </execution>
                    <execution>
                        <id>zip-all</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <descriptors>
                                <descriptor>src/assembly/assembly.xml</descriptor>
                            </descriptors>
                            <finalName>${project.artifactId}-${project.version}</finalName>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
    <repositories>
        <repository>
            <id>porua-repo</id>
            <name>Porua Repository</name>
            <url>https://github.com/anupamgogoi0907/porua-docs/raw/repo</url>
            <snapshots>
                <enabled>true</enabled>
                <updatePolicy>always</updatePolicy>
            </snapshots>
            <releases>
                <enabled>true</enabled>
            </releases>
        </repository>
    </repositories>
</project>

Now go to the root directory of the project and execute the following commands in sequence:

  • mvn archetype:create-from-project

This command will generate the archetype from the existing Maven project. You can check the generated files at the following location:

target/generated-sources/archetype

Image title

Now at this point, you can do two more important things:

  • Modify the target/generated-sources/archetype/pom.xml to add extra things if you need
  • Modify target/generated-sources/archetype/src/main/resources/META-INF/maven/archetype-metadata.xml to include/exclude files etc in the archetype. (Please read Maven's official documents for more information)

mvn clean install

Execute this command on target/generated-sources/archetype/pom.xml. It will install the plugin in your local repository.

mvn archetype:generate -DarchetypeCalalog=local

Execute this command to check your archetype available in the local repository.

Using The Archetype

At this point, our archetype is installed successfully in our local Maven repository. Let's try to make use of it. Use this command to make a project from the archetype:

mvn -B archetype:generate \
-DarchetypeGroupId=com.porua \
-DarchetypeArtifactId=archetype-porua-archetype
-DgroupId=com.mycompany.app \
-DartifactId=my-app

Conclusion

That's it. It's very simple to create a Maven archetype from an existing project.

Archetype (information science) Apache Maven

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Introduction To OpenSSH
  • Solving the Kubernetes Security Puzzle
  • How To Choose the Right Streaming Database
  • Testing Level Dynamics: Achieving Confidence From Testing

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: