jgitver Maven introduction on docker

Difficulty: Beginner

Estimated Time: 10 minutes

Welcome to this jgitver maven demo.

In this tutorial, you will see how to integrate jgitver into an existing maven project.

jgitver will allow automatic project version computation based on git information (tags, commits, branches, ...)

jgitver maven simple usage

For now let's move to the next slide.

https://jgitver.github.io

You're done, you have successfully used jgitver and its jgitver-maven-plugin: congratulations!

Feel free now to:

follow the other training scenarios
consult the jgitver and jgitver-maven-plugin documentations
ask questions and chat on gitter

Your environment is currently being packaged as a Docker container and the download will begin shortly. To run the image locally, once Docker has been installed, use the commands

cat scrapbook_mcfoggy_jgitver/maven-intro_container.tar | docker load

docker run -it /mcfoggy_jgitver/maven-intro:

Restart Scenario

Next Scenario

Step 1 of 3

project initialization

Open a docker container with all the required tooling: maven, git.

docker run -it --rm maven:3.5 /bin/bash

Let's create a default maven project.

mvn archetype:generate \ -DgroupId=fr.brouillard.jgitver.demos \ -DartifactId=simple-maven-demo \ -Dversion=1.0.0-SNAPSHOT \ -Dpackage=fr.brouillard.jgitver.demos \ -DarchetypeArtifactId=maven-archetype-quickstart \ -DinteractiveMode=false \ -DarchetypeCatalog=local

With some git history

cd simple-maven-demo && \ git init && \ git config user.name "Scrap Kata-Coda" && \ git config user.email "[email protected]" && \ git config --global alias.lg "log --color --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit" && \ echo target/ > .gitignore && \ git add . && \ git commit -m "initial version"

We now have a default running maven project

mvn validate

which version is defined by the pom version node as 1.0.0-SNAPSHOT

grep -E --color=auto '^.*1.0.0-SNAPSHOT.*$|$' pom.xml

jgitver installation

Now that we have a running project, let's use jgitver on it.

The jgitver-maven-plugin is a core maven extension that needs to be declared inside a file .mvn/extensions.xml.

Do not bother on the syntax, we've prepared some automatic scripts for you that you can also retrieve on jgitver-maven-plugin main page.

Let's install it.

sh -c "$(wget -q https://git.io/fA6sj -O -)"

Now verify that jgitver operates by checking with maven the calculated project version
mvn validate

jgitver should have hooked in maven build and printed the following

...
[INFO] jgitver-maven-plugin is about to change project(s) version(s)
[INFO]     fr.brouillard.jgitver.demos::simple-maven-demo::1.0.0-SNAPSHOT -> 0.0.0-SNAPSHOT
...

Version is now overridden by jgitver to 0.0.0-SNAPSHOT using the history of the project.
git lg

Using no special configuration, project versioning starts with 0.0.0 and uses SNAPSHOT qualifier.

git tagging

In order to be clean, we first need to commit the created maven extension file
git add . && git commit -m "add jgitver maven extension"

Our project now has 2 commits git lg

And its version is still calculated by jgitver to 0.0.0-SNAPSHOT mvn validate

tagging

Now let's terminate with one of the main interesting feature of jgitver: tagging:

create an annotated release tag:
git tag -a -m "release 1.0" 1.0
verify the tag is there and that git HEAD is on the tag git lg
now maven project version calculated by jgitver should be 1.0.0:
mvn validate

jgitver should have hooked in maven build and printed the following

...
[INFO] jgitver-maven-plugin is about to change project(s) version(s)
[INFO]     fr.brouillard.jgitver.demos::simple-maven-demo::1.0.0-SNAPSHOT -> 1.0.0
...

Terminal

cd <directory>	Change directory
ls	List directory
echo 'contents' > <file>	Write contents to a file
cat <file>	Output contents of file

i	In Command Mode	Change into Insert Mode, you can now insert and edit text in the file
esc	In Insert Mode	Change into Command Mode, you can now execute commands
:wq	In Command Mode	Save and Exit

Welcome!

jgitver Maven introduction on docker

Congratulations!

You've completed the scenario!

Scenario Rating

Steps