This github template repository contains a basic maven project ready for the eitco open source ci. It contains:
This readme, you are currently viewing. In a generated project it needs to be replaced. See the TODO-commentary for some ideas.
By default, eitco open source software is licensed under the MIT license. To change this, simply replace this file
The directories .github
and deployment
contain the CI. While the directory .github
contains actions that build
each commit and release the project on demand, the directory deployment
contains configuration for the release.
A lot of the build however is configured by the project object model (pom.xml).
This file specifies the build for your project. Make sure to adapt it according to the TODOs. A lot of the
CI is inherited from the eitco-oss-parent
pom.
The .mvn
directory activates and configures the maven-git-versioning-extension
. This extension changes the
projects version depending on the current branch. This way every branch can be deployed without their artifacts
overriding each other.