Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 3.44 KB

README.md

File metadata and controls

84 lines (58 loc) · 3.44 KB
Raw

jGuru Codestyle

Put simply - the codestyle project contains all those settings and configurations which makes your development, deployment and runtime execution just work. The jGuru Codestyle project contains a implemented set of best-pracises to start projects quickly - and scale those projects without needing to change your development and delivery process. This is in part usability engineering for the development process, and in part a lot of experience in software development ... all in one repo.

Current Build Status:

What does the Codestyle Repository do?

The Codestyle repository defines how to build the build. For kotlin projects, simply use the various parents as parent within the projects within your other repositories. A typical repository structure is shown in the image below:

  1. Codestyle repository: Single Respository which defines the build, including Maven plugin configuration and parent POMs for different types of project. Normally OSS, since there is no domain information in these components.
  2. Shared components repository: Single Repository which contains components aimed at simplifying or harmonizing using the standards, such as various bits of the JavaEE / EE4J stack. Typically OSS, since there is no domain information in these components.
  3. Domain definition repositories: One or more Repositories which contain domain definition and usage components. These domain components may/should depend on components from the Shared component repository, to ensure that all in-house standards are adhered to. This is normally where the business secrets and competitive advantages are stored - and hence lends itself well to closed-source licensing.
  4. Application repositories: One or more Repositories which assemble domain definitions into JavaEE deployment archives (typically WAR, EAR or JAR archives) and the corresponding runtime structure, termed "Assemblies".

2. Getting and building jGuru Codestyle

The jguru-codestyle is a normal Git-based Maven project, which is simple to clone and quick to build.

2.1. Getting the repository

Clone the repository, and fetch all tags:

git clone https://github.com/lennartj/jguru-codestyle.git

cd jguru-codestyle

git fetch --tags

2.2. Building the jguru-codestyle project

For the latest development build, simply run the build against the latest master branch revision:

mvn clean install

For a particular version, checkout its release tag and build normally:

git checkout jguru-codestyle-1.2.4

mvn clean install

All tags (and hence also all release versions) are visible using the command

git tag -l

2.2.1. Building with different Maven versions

For building the project with another Maven version, simply run the following script, where the ${MAVEN_VERSION} should be substituted for a version number such as 3.3.3:

mvn -N io.takari:maven:wrapper -Dmaven=${MAVEN_VERSION}

./mvnw --show-version --errors --batch-mode validate dependency:go-offline

./mvnw --show-version --errors --batch-mode clean verify site

In the windows operating system, use mvnw.bat instead.