GitLab-CI get pom version in pipeline

Question

I'd like to build docker image via gitlab CI with project's version as a tag:

docker build -t dockerimage:VERSION-IN-POM .

In jenkins' pipeline i'm getting the version like that:

${pom.version}

Is it possible to read the version in a similar, convenient way from gitlab CI? Or do I have to write scripts for that?

I don't believe there is one, however you can write a `before_script` that would `sed` the version from your pom file. In Jenkins there are plugins that can simplify such tasks, however GitLab CI doesn't really have such. — Neekoy, Sep 05 '18 at 15:50

score 12 · Answer 1 · answered Sep 09 '18 at 05:23

12

Assuming you have maven in build environment, you could use maven help plugin and grep to extract version.

VERSION=$(mvn --non-recursive help:evaluate -Dexpression=project.version | grep -v '\[.*')
echo $VERSION

answered Sep 09 '18 at 05:23

Ruwanka Madhushan

3,195
5
33
48

2

i had to tail the output, my final statement: VERSION=$(mvn --batch-mode --non-recursive help:evaluate -Dexpression=project.version | grep -v '\[.*' | tail -1) – Mulder Feb 20 '19 at 11:08

score 7 · Answer 2 · answered Sep 05 '18 at 20:10

Gitlab-CI doesn't offer such comforts, instead it offers you to do whatever you want with the shell script. It's not very hard to do it in command script. You can install xmllint (apt install libxml2-utils on Ubuntu) and then you can get it by a simple query:

xmllint --xpath '/*[local-name()="project"]/*[local-name()="version"]/text()' pom.xml

So it can all be solved by these two lines:

- apt install libxml2-utils
- docker build -t dockerimage:$(xmllint --xpath '/*[local-name()="project"]/*[local-name()="version"]/text()' pom.xml) .

Not really, what if it inherits the version from a propert file or from a parent? — yerlilbilgin, Sep 08 '21 at 09:09

score 6 · Answer 3 · edited Mar 22 '22 at 11:04

6

This work for my variable: gitlab-ci.yml

mvn -Dexec.executable='echo' -Dexec.args='${project.version}' --non-recursive exec:exec -q

edited Mar 22 '22 at 11:04

Jasper de Vries

16,868
6
60
93

answered May 26 '19 at 08:11

Erik Roky

71
1
4

score 2 · Answer 4 · answered Feb 27 '20 at 17:56

2

You can use sed or grep.

It's faster than using mvn --non-recursive help:evaluate ...

Get the artifactID

grep -m1 '<artifactId>' pom.xml | grep -oP  '(?<=>).*(?=<)'

Get the version

grep -m1 '<version>' pom.xml | grep -oP  '(?<=>).*(?=<)'

If you are using docker, some images don't have newest version of grep, so you need to use come creative solution with cut, example:

grep -m1 '<artifactId>' pom.xml |cut -d '<' -f2  |cut -d '>' -f2

answered Feb 27 '20 at 17:56

Joao Vitorino

2,641
2
29
50

1

"creative cut solution " helped ;) Thanks – Anand Varkey Philips Jul 09 '20 at 15:36

score 2 · Answer 5 · answered Nov 19 '20 at 18:17

2

Another maven command line alternative to get directly get the version information

mvn --non-recursive help:evaluate -Dexpression=project.version -q -DforceStdout

answered Nov 19 '20 at 18:17

Reinhard Braumandl

21
1

score 1 · Answer 6 · answered Sep 08 '21 at 09:19

if you know the project name, here is another approach using shell; is to cut the version from the target .jar file created under ./target directory.

Note: This will work only after successful build commands:

   cd target
   version=`ls <PROJECT_NAME>*.jar`
   version=${version#<PROJECT_NAME>} 
   version=${version%.jar}
   cd ..
   echo $version

<PROJECT_NAME> is the name of the project (use without <> marks)

score 1 · Answer 7 · edited Jun 01 '22 at 17:20

1

You can use the below command in your .gitlab-ci.yml file :

VERSION=$(mvn --non-recursive help:evaluate -Dexpression=project.version -q -DforceStdout)

echo $VERSION

Furthermore you can get groupId and artifactId by changing Dexpression=project.version to Dexpression=project.artifactId and Dexpression=project.groupId

For more information see the maven documentation for help:evaluate.

edited Jun 01 '22 at 17:20

Besworks

2,418
12
31

answered Nov 16 '21 at 08:15

DaniyalVaghar

98
1
8

score 0 · Answer 8 · answered Sep 26 '19 at 13:24

0

As indicated by Ivan in his post, this worked in my script:

-RELEASE_VERSION=xmllint --xpath '/*[local-name()="project"]/*[local-name()="version"]/text()' pom.xml

-echo $RELEASE_VERSION

answered Sep 26 '19 at 13:24

luis-br

473
5
9

score 0 · Answer 9 · answered Mar 22 '22 at 12:56

I ended up using

vars:
  stage: prepare
  script:
    - echo "POM_VERSION=$(mvn -Dexec.executable='echo' -Dexec.args='${project.version}' --non-recursive exec:exec -q)" > vars.env
    - echo "POM_NAME=$(mvn -Dexec.executable='echo' -Dexec.args='${project.name}' --non-recursive exec:exec -q)" >> vars.env
    - echo "POM_GROUP_ID=$(mvn -Dexec.executable='echo' -Dexec.args='${project.groupId}' --non-recursive exec:exec -q)" >> vars.env
    - echo "POM_ARTIFACT_ID=$(mvn -Dexec.executable='echo' -Dexec.args='${project.artifactId}' --non-recursive exec:exec -q)" >> vars.env
  artifacts:
    reports:
      dotenv: vars.env

GitLab-CI get pom version in pipeline

9 Answers9