# The Knetminer archetype
This is a Maven Archetype project, which helps to define new Knetminer-related projects that contains common elements and pointers to our resources. See the main README for details.
When you generate a new Maven project with this artifact, you have a starting skeleton, which links to our common POM (see the link above) and inherits copies of common files like the ones needed for GitHub Actions deployment.
You can easily generate a new project (ie, Maven module) from a Bash-compatible shell, by typing something like:
curl -L https://tinyurl.com/knetminer-archetype-sh | sh -s uk.ac.rothamsted.knetminer sample-jar 1.0-SNAPSHOTwhere, of course, the three parameters are the new artifact's coordinates.
WARNING: the script above might not work due to the need to define our own Maven repository in your .m2/settings.xml. If needed, use the definitions in our main POM.
The new project is a simple jar project. The common elements it contains include:
- A POM file that inherits from our common POM, defining common third party dependencies (eg, log4j2) and coordinates to download/deploy with our team artifactory
- A simple Travis file, which downloads our common Maven settings and deploys your new project on our artifactory
- A convenience .gitignore file
WARNING: The default .gitignore files ignores files in ci-build/*, since our scripts download them from our repo and, by default, those files aren't meant to be duplicated in derived projects.
To Windows users: while we haven't tried it yet, we're confident that you can reproduce what the command above does manually. That is, download this hereby archetype project as a dependency in your local Maven, then launch the Archetype plugins. This is simply what the above script does.