CODEWITHSUNDEEP
mavendockergitlabgitlab-ci
Krzysztof Bielak
Krzysztof Bielak

Reputation: 503

GitLab-CI get pom version in pipeline

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?

Upvotes: 20

Views: 23823

Answers (12)

raisercostin
raisercostin

Reputation: 9189

Without assuming anything, and using versions for build reproductibility, and bonus caching maven:

build:
  stage: build
  cache:
    key: maven
    paths:
      - .m2/repository
  script:
    # Extract Maven version
    - export MAVEN_VERSION=$(docker run --rm -v $CI_PROJECT_DIR:/app -w /app maven:3.8.4-openjdk-11-slim mvn org.apache.maven.plugins:maven-help-plugin:3.1.1:evaluate -Dexpression=project.version -q -DforceStdout)

Upvotes: 0

ololoid
ololoid

Reputation: 109

jobname:
  stage: stage
  before_script:
    - export "MAVEN_ID=$(mvn help:evaluate -Dexpression=project.id -q -DforceStdout)"
    - >
      IFS=: read -r MAVEN_GROUPID MAVEN_ARTIFACTID MAVEN_PACKAGING MAVEN_VERSION <<< ${MAVEN_ID}
  script:
    - >
      echo -e "groupId: ${MAVEN_GROUPID}\nartifactId: ${MAVEN_ARTIFACTID}\nversion: ${MAVEN_VERSION}\npackaging: ${MAVEN_PACKAGING}"
  • mvn help:evaluate -Dexpression=project.id -q -DforceStdout prints artifact identification information in the following format: com.group.id:artifactid:packaging:version
  • MAVEN_ID variable is parsed using IFS based on the colon (:) as a separator to get common maven variables like artifactId, groupId, version and packaging (explanation)
  • later these variables can be used in the code, for example for echoing values
  • this way maven is executed only 1 time to get the information, which can speed up pipeline
  • IFS is a bash feature, thus corresponding GitLab runner should have bash installed

Upvotes: 0

jpmottin
jpmottin

Reputation: 3017

Here is a solution with the Maven help:evaluate but with a regex (see the "-E" in command) :

export VERSION=$(mvn --non-recursive help:evaluate -Dexpression=project.version | grep -E '^[0-9]+.[0-9]+.[0-9]+(-[A-Z]+)?$')
echo $VERSION

It will be able to find for example 5.0.1-SNAPHOT or only 5.0.1 or again 5.0.1-GA in the output of the Maven command.

Tested on this kind of realistic Maven output :

Downloaded from fodfin: http://your.server/artifactory/com/thoughtworks/xstream/xstream/1.4.11.1/xstream-1.4.11.1.jar (621 kB at 369 kB/s)
[INFO] No artifact parameter specified, using 'be.test.super.package:the-application:pom:5.0.1-SNAPSHOT' as project.
[INFO]
5.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  15.127 s
[INFO] Finished at: 2022-10-06T14:40:29+02:00
[INFO] ------------------------------------------------------------------------

Upvotes: 1

DaniyalVaghar
DaniyalVaghar

Reputation: 179

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.

Upvotes: 3

Jasper de Vries
Jasper de Vries

Reputation: 20198

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

Upvotes: 1

Erik Roky
Erik Roky

Reputation: 129

This work for my variable: gitlab-ci.yml

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

Upvotes: 12

yerlilbilgin
yerlilbilgin

Reputation: 3409

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)

Upvotes: 1

Reinhard Braumandl
Reinhard Braumandl

Reputation: 51

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

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

Upvotes: 5

Joao Vitorino
Joao Vitorino

Reputation: 3256

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

Upvotes: 3

luisbr
luisbr

Reputation: 523

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

Upvotes: 1

Ruwanka De Silva
Ruwanka De Silva

Reputation: 3755

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

Upvotes: 14

Jakub Kania
Jakub Kania

Reputation: 16487

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) .

Upvotes: 8

Related Questions