Maven proje sürümünü bash komut satırına alma

Daha önce Maven proje sürümünün komut satırından nasıl değiştirileceğine dair bir soru yayınladım ve bu da beni yeni bir soruna götürdü .

Daha önce, sürümün komut satırından (bash) grep ve ayrıştırması kolay bir özellik olarak saklandığından sürüm numarasını alabildim. Şimdi pom.xml öğesi bunun için kullanıldığına göre, tüm bağımlılıklar ve belki de bazıları da bunu kullandığından artık benzersiz değil. Ben xml veya bazı çok bağlam-bilinçli sed komut ayrıştırmak için harici araçlar olmadan bir bash betiği ile mevcut sürüm numarasını almak için bir yol olduğunu düşünüyorum .

Benim düşüncemdeki en temiz çözüm Maven'in bu sürüm bilgilerini dağıtması olacaktır. Farklı özellikleri almak için özel bir maven eklentisi yazmayı düşünüyordum ama önce burada soracağımı düşündüm.

Peki, ${project.version}komut satırının değerini almanın kolay bir yolu var mı? Şimdiden teşekkürler.

Çözüm

Yardım için teşekkürler. Ben cddizine manuel olarak vardı ama bu kolayca yapılabilir. Benim bash senaryomda var

version=`cd $project_loc && mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | sed -n -e '/^\[.*\]/ !{ /^[0-9]/ { p; q } }'`

Bu da bana ilerleyebileceğim güncel sürümü veriyor. Selamlamak daha kolay olabilir, ancak olabildiğince sağlam olmasını istediğimi düşündüm, bu yüzden bir sayı ile başlayan ilk satırdan memnunum ve bunu bir sürüm numarası olarak ele almaya çalışıyorum.

# Advances the last number of the given version string by one.
function advance_version () {
    local v=$1
    # Get the last number. First remove any suffixes (such as '-SNAPSHOT').
    local cleaned=`echo $v | sed -e 's/[^0-9][^0-9]*$//'`
    local last_num=`echo $cleaned | sed -e 's/[0-9]*\.//g'`
    local next_num=$(($last_num+1))
    # Finally replace the last number in version string with the new one.
    echo $v | sed -e "s/[0-9][0-9]*\([^0-9]*\)$/$next_num/"
}

Ve bunu sadece arayarak kullanıyorum

new_version=$(advance_version $version)

Umarım bu birine yardımcı olur.

Maven Yardım Eklenti nasılsa zaten bunun için bir şeyler öneriyor:

• help:evaluate Etkileşimli modda kullanıcı tarafından verilen Maven ifadelerini değerlendirir.

Bunu almak için komut satırında nasıl çağırırsınız ${project.version}:

mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate \
    -Dexpression=project.version

Tom'un Exec Maven Eklentisi ile çözümü çok daha iyidir, ancak olması gerekenden daha karmaşıktır. Benim için bu kadar basit:

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

Biraz araştırma yaptım ve aşağıdakileri buldum:

1. Maven, DevOps araçlarıyla entegrasyonun CLI araçlarıyla ilgili bazı iyi uygulamaları izlememesi nedeniyle kolay olmadığı için suçlandı. (ref: https://youtu.be/1ILEw6Qca3U?t=372 )

2. Önceki iddiadan esinlenerek, maven'in kaynak kodunun yanı sıra maven-help-plugin'e de bakmaya karar verdim. Biraz maven'in -q anahtarını (sürüm 3.5.3 kullanıyorum) düzelttikleri anlaşılıyor, bu yüzden şimdi geçerseniz, maven'in kullanılmasını engelleyen tüm can sıkıcı mantıksız günlük kayıtlarını alamayacaksınız otomatik komut dosyaları içinde. Yani böyle bir şey kullanabilmelisiniz:

   mvn help:evaluate -Dexpression=project.version -q

   Sorun, bu komutun hiçbir şey yazdırmamasıdır, çünkü varsayılan olarak yardım eklentisi -q anahtarı tarafından susturulan günlükçiden çıkar. (Eklentinin mevcut en son sürümü 3 Haziran 2018'de 3.1.0 yayımlandı)

3. Karl Heinz Marbaise ( https://github.com/khmarbaise ), aşağıdaki şekilde çağırmanıza izin veren isteğe bağlı bir parametre ekleyerek düzeltti:

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

   Taahhüt açıklaması şu adreste bulunabilir: ( https://github.com/apache/maven-help-plugin/commit/316656983d780c04031bbadd97d4ab245c84d014 )

mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | grep -v '\['

En iyi cevap bence oldukça çöp, maven konsolu çıkışını kesmek için bir grup grep kullanmanız gerekiyor. Neden iş için doğru aleti kullanmıyorsunuz? XML veri yapısına erişmek için amaçlanan yöntem olduğundan, xpath sözdizimini kullanmak sürüm numarasını almak için en iyi yaklaşımdır. Aşağıdaki ifade, öğelerin "yerel adı" kullanılarak pom'a geçilir, diğer bir deyişle xml'de bulunabilen veya bulunmayan ad alanı bildirimlerini yok sayar.

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

Bu, günlük girişlerini çıkıştan ayırma ihtiyacını önler:

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

Bulduğum en temiz çözüm :

mvn org.apache.maven.plugins:maven-help-plugin:3.2.0:evaluate -Dexpression=project.version -q -DforceStdout

Avantajları:

• Bu, tüm işletim sistemlerinde ve tüm kabuklarda iyi çalışır .
• Harici aletlere gerek yok!
• [önemli] Proje sürümü üst öğeden devralınsa bile bu işe yarar pom.xml

Not:

• maven-help-pluginsürümü 3.2.0(ve üstü) forceStdoutseçeneği vardır. 3.2.0Yukarıdaki komutta , varsa yapay nesne için mevcut mvn-help-plugin sürümleri listesinden daha yeni bir sürümle değiştirebilirsiniz .
• Seçenek -qmesajları ayrıntılı bastırır ( [INFO], [WARN]vs.)

Getirmek istiyorsanız groupIdve bu yanıtı daartifactId kontrol edin .

python -c "import xml.etree.ElementTree as ET; \
  print(ET.parse(open('pom.xml')).getroot().find( \
  '{http://maven.apache.org/POM/4.0.0}version').text)"

Python 2.5 veya daha büyük bir süreye sahip olduğunuz sürece, bu işe yaramalıdır. Bundan daha düşük bir sürüme python-lxmlsahipseniz, içe aktarmayı yükleyin ve lxml.etree olarak değiştirin. Bu yöntem hızlıdır ve ek eklentilerin indirilmesini gerektirmez. Ayrıştırmam gereken dosyalar gibi xmllint ile doğrulanmayan hatalı biçimlendirilmiş pom.xml dosyalarında da çalışır. Mac ve Linux'ta test edilmiştir.

Buradaki diğer cevaplardan bazılarını kullanırken yan davalara girmeye devam ettim, işte başka bir alternatif.

version=$(printf 'VER\t${project.version}' | mvn help:evaluate | grep '^VER' | cut -f2)

Sürümü geçici bir dosyaya yazmanın sakıncası yoksa, benim için iyi çalışan başka bir çözüm (grep / sed olmadan) var. ( DÜZENLEME : rjrjr'ın geçici dosya sıkıntısı olmadan çok daha basit bir çözüm için cevabına bakın )

Ben ikili ile birlikte Exec Maven Eklentisi kullanıyorum echo. Maven Yardım Eklentisinin aksine, Exec Eklentisi, grep / sed'i atlamak için kullanılabilen bir dosyaya çıktı yönlendirmesine izin verir ve çok satırlı sürüm dizeleri (sürüm etiketinde CDATA bloğu ile) gibi garip şeyleri ayrıştırmayı bile mümkün kılar, en azından bir dereceye kadar.

#!/usr/bin/env sh

MVN_VERSION=""
VERSION_FILE=$( mktemp mvn_project_version_XXXXX )
trap "rm -f -- \"$VERSION_FILE\"" INT EXIT

mvn -Dexec.executable="echo" \
    -Dexec.args='${project.version}' \
    -Dexec.outputFile="$VERSION_FILE" \
    --non-recursive \
    --batch-mode \
    org.codehaus.mojo:exec-maven-plugin:1.3.1:exec > /dev/null 2>&1 ||
    { echo "Maven invocation failed!" 1>&2; exit 1; }

# if you just care about the first line of the version, which will be
# sufficent for pretty much every use case I can imagine, you can use
# the read builtin
[ -s "$VERSION_FILE" ] && read -r MVN_VERSION < "$VERSION_FILE"

# Otherwise, you could use cat.
# Note that this still has issues when there are leading whitespaces
# in the multiline version string
#MVN_VERSION=$( cat "$VERSION_FILE" )

printf "Maven project version: %s\n" "$MVN_VERSION"

Sadece kayıt için, Maven'in Basit SLF4J günlüğünü doğrudan komut satırında yapılandırarak yalnızca yapılandırarak ihtiyacımız olanı çıkaracak şekilde yapılandırmak mümkündür:

• org.slf4j.simpleLogger.defaultLogLevel=WARN ve
• org.slf4j.simpleLogger.log.org.apache.maven.plugins.help=INFO

http://www.slf4j.org/api/org/slf4j/impl/SimpleLogger.html adresinde belgelendiği gibi

MAVEN_OPTS="\
-Dorg.slf4j.simpleLogger.defaultLogLevel=WARN \
-Dorg.slf4j.simpleLogger.log.org.apache.maven.plugins.help=INFO" \
mvn help:evaluate -o -Dexpression=project.version

Sonuç olarak, basit bir şekilde çalışabilir tail -1ve şunları elde edebilir:

$ MAVEN_OPTS="\
-Dorg.slf4j.simpleLogger.defaultLogLevel=WARN \
-Dorg.slf4j.simpleLogger.log.org.apache.maven.plugins.help=INFO" \
mvn help:evaluate -o -Dexpression=project.version | tail -1

1.0.0-SNAPSHOT

Bunun bir astar olduğunu unutmayın. MAVEN_OPTSyalnızca bu özel mvnuygulama için yeniden yazılıyor.

Downloaded:Çıktının içinde, orijinal görevimi bozan bazı sahte çizgiler fark ettim . İşte yerleştiğim filtre; Umarım yardımcı olur!

version=$(mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | egrep -v '^\[|Downloading:' | tr -d ' \n')

DÜZENLE

Neden% 100 emin değilim, ancak bunu Jenkins'te bir post-build betiği ile çalıştırırken, çıktı [INFO]version, örneğin çıktı [INFO]0.3.2.

Çıktıyı bir dosyaya döktüm ve ilk filtremden doğrudan BASH'den çalıştırdım, iyi çalışıyor .., bu yüzden tekrar Jenkins arazisinde neler olduğundan emin değilim.

Jenkins'te% 100 almak için bir takip sedfiltresi ekledim ; işte en son benim

version=$(mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | egrep -v '^\[|Downloading:' | tr -d ' \n' | sed -E 's/\[.*\]//g')

DÜZENLE

Son bir not burada .. öğrendim tredildi hala gibi şeyler sonuçlanan /r/n0.3.2(Jenkins yoluyla çalıştırırken tekrar okunur). Geçti awkve sorun ortadan kalktı! Son çalışma sonucum

mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version \
| egrep -v '^\[|Downloading:' | sed 's/[^0-9\.]//g' | awk 1 ORS=''

Sadece basit bir maven çözümü

mvn -q -N org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \
    -Dexec.executable='echo' \
    -Dexec.args='${project.version}'

Ve bonus puanlar için bir sürümün parçası ayrıştırıldı

mvn -q -N org.codehaus.mojo:build-helper-maven-plugin:3.0.0:parse-version \
    org.codehaus.mojo:exec-maven-plugin:1.3.1:exec \
    -Dexec.executable='echo' \
    -Dexec.args='${parsedVersion.majorVersion}.${parsedVersion.minorVersion}.${parsedVersion.incrementalVersion}'

Kısa bir süre önce bu kesin sorunu çözen Release Candidate Maven eklentisini geliştirdim, böylece herhangi bir hacky kabuk komut dosyasına başvurmanız vemaven-help-plugin .

Örneğin, Maven projenizin sürümünü bir terminale yazdırmak için şunu çalıştırın:

mvn com.smartcodeltd:release-candidate-maven-plugin:LATEST:version

aşağıdakine benzer çıktılar verir maven-help-plugin:

[INFO] Detected version: '1.0.0-SNAPSHOT'
1.0.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

Bununla birlikte, isteğe bağlı bir çıktı biçimi de belirtebilirsiniz (böylece sürümün TeamCity gibi bir CI sunucusu tarafından günlükten alınabilmesi için ):

mvn com.smartcodeltd:release-candidate-maven-plugin:LATEST:version \
   -DoutputTemplate="##teamcity[setParameter name='env.PROJECT_VERSION' value='{{ version }}']"

Sonuç:

[INFO] Detected version: '1.0.0-SNAPSHOT'
##teamcity[setParameter name='env.PROJECT_VERSION' value='1.0.0-SNAPSHOT']
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------

Bir dosyaya (böylece gibi bir CI sunucusu olduğu çıktı kaydetmek için Jenkins olabilir kullanmak ):

mvn com.smartcodeltd:release-candidate-maven-plugin:LATEST:version \
   -DoutputTemplate="PROJECT_VERSION={{ version }}" \
   -DoutputUri="file://\${project.basedir}/version.properties"

Ortaya çıkan version.propertiesdosya aşağıdaki gibi görünecektir:

PROJECT_VERSION=1.0.0-SNAPSHOT

Yukarıdakilerin hepsinde, Sürüm Adayı da sürümü ayarlamanızı sağlar projenizin (muhtemelen CI sunucunuzda yapacağınız bir şey) POM'nizde tanımladığınız API sürümüne göre .

Maven yaşam döngüsünün bir parçası olarak Sürüm Adayı örneğinin kullanıldığını görmek isterseniz, pom.xmldiğer açık kaynaklı projeme - Jenkins için Monitor'u inceleyin .

Maven'e ihtiyaç duymayan bir seçenek de var:

grep -oPm1 "(?<=<version>)[^<]+" "pom.xml"

Maven proje sürümünü çıkaran, çıktıların [INFO]ve Downloadiletilerin dışına çıkan çıktıları bastıran anlaşılması kolay hepsi bir arada çözüm :

mvn -o org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | grep -v '\['

Aynı şey, ama iki satıra bölünmüş:

mvn -o org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate \
      -Dexpression=project.version | grep -v '\['

Çıktılar: 4.3-SNAPSHOT

Yani, project.versionbasit bir bash komut dosyasında kullanarak :

projectVersion=`mvn -o org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | grep -v '\['`
cd "target/"$projectVersion"-build"

Bu sayfadaki diğer çözümler tüm hileleri bir araya getirmedi.

Bu hata maven-help-plugin 3.0.0'da düzeltildiğinden daha kolay olmalı: MPH-99 Değerlendirmenin sessiz modda çıkışı yok .

Bu, en kolay bash kesme ve yapıştırma çözümüdür:

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

yankılanıyor

1.4

Benim için doğru dengeyi buldum. mvn packageMaven-archiver eklentisi target/maven-archiver/pom.propertiesböyle içeriklerle oluşturulduktan sonra

version=0.0.1-SNAPSHOT
groupId=somegroup
artifactId=someArtifact

ve bash'ı sadece yürütmek için kullanıyorum

. ./target/maven-archiver/pom.properties

sonra

echo $version
0.0.1-SNAPSHOT

Tabii ki bu, bu dosyayı yürütmek için güvenli değildir, ancak yürütme, bu dosyadaki ortam değişkenini okumak ve ayarlamak için kolayca perl veya bash komut dosyasına dönüştürülebilir.

Bu benim için, çevrimdışı ve mvn bağlı olmadan çalıştı:

VERSION=$(grep --max-count=1 '<version>' <your_path>/pom.xml | awk -F '>' '{ print $2 }' | awk -F '<' '{ print $1 }')
echo $VERSION

Exec eklentisi, çıktı ayrıştırılmadan çalışır çünkü çıktı EnvInject eklentisi aracılığıyla dosyaya yönlendirilebilir ve iş ortamına geri enjekte edilebilir:

Soruya dayanarak, tüm maven ebeveyn / alt modüllerinde sürüm numaramı otomatik olarak artırmak için aşağıdaki bu komut dosyasını kullanıyorum:

#!/usr/bin/env bash  

# Advances the last number of the given version string by one.  
function advance\_version () {  
    local v=$1  
    \# Get the last number. First remove any suffixes (such as '-SNAPSHOT').  
  local cleaned=\`echo $v | sed \-e 's/\[^0-9\]\[^0-9\]\*$//'\`  
 local last\_num=\`echo $cleaned | sed \-e 's/\[0-9\]\*\\.//g'\`  
 local next\_num=$(($last\_num+1))  
  \# Finally replace the last number in version string with the new one.  
  echo $v | sed \-e "s/\[0-9\]\[0-9\]\*\\(\[^0-9\]\*\\)$/$next\_num/"  
}  

version=$(mvn org.apache.maven.plugins:maven-help-plugin:3.2.0:evaluate -Dexpression=project.version -q -DforceStdout)  

new\_version=$(advance\_version $version)  

mvn versions:set -DnewVersion=${new\_version} -DprocessAllModules -DgenerateBackupPoms=false

Ya size mvncevabı verdiniz (çoğu cevabın önerdiği gibi) ya da cevabı pom.xml. İkinci yaklaşımın tek dezavantajı, <version/>etiketin değerini çok kolay bir şekilde ayıklayabilmenizdir , ancak yalnızca gerçek bir kelime , yani bir Maven mülkü değilse anlamlı olacaktır . Yine de bu yaklaşımı seçtim çünkü:

• mvn ayrıntılı bir yol ve sadece çıkışını filtrelemeyi sevmiyorum.
• Başlangıç mvn, okumaya kıyasla çok yavaşpom.xml .
• İçinde her zaman değişmez değerler kullanırım <version/>.

mvn-versionprojenin sürümünü (varsa) veya üst projenin sürümünü (varsa) okumak ve yazdırmak için zshkullanılan bir kabuk komut dosyasıdır :xmlstarletpom.xml

$ mvn-version .
1.0.0-SNAPSHOT

Avantajı olmasıdır yolu çalışan daha hızlı mvn:

$ time mvn-version .
1.1.0-SNAPSHOT
mvn-version .  0.01s user 0.01s system 75% cpu 0.019 total

$ time mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate \
> -Dexpression=project.version
mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate   4.17s user 0.21s system 240% cpu 1.823 total

Makinemdeki fark iki büyüklükten daha büyük.

Travis işim sırasında tam olarak bu gereksinime ihtiyacım var ama birden fazla değerle. Bu çözümle başlıyorum ama birden fazla zaman çağırırken bu çok yavaş (5 ifade gerekir).

Pom.xml'nin değerlerini .sh dosyasına ayıklamak için basit bir maven eklentisi yazdım.

https://github.com/famaridon/ci-tools-maven-plugin

mvn com.famaridon:ci-tools-maven-plugin:0.0.1-SNAPSHOT:environment -Dexpressions=project.artifactId,project.version,project.groupId,project.build.sourceEncoding

Bunu üretecek:

#!/usr/bin/env bash
CI_TOOLS_PROJECT_ARTIFACTID='ci-tools-maven-plugin';
CI_TOOLS_PROJECT_VERSION='0.0.1-SNAPSHOT';
CI_TOOLS_PROJECT_GROUPID='com.famaridon';
CI_TOOLS_PROJECT_BUILD_SOURCEENCODING='UTF-8';

şimdi dosyayı kolayca kaynaklayabilirsiniz

source .target/ci-tools-env.sh

İyi eğlenceler.

Unix kabuğumda bir astar kullanıyorum ...

kedi pom.xml | grep "" | kafa -n 1 | sed -e "s / sürüm // g" | sed -e "s / \ s * [<> /] * // g"

Bu satırı bir kabuk komut dosyasında veya takma ad olarak gizleyebilirsiniz.

bu yukarıdan bir düzenleme

kedi pom.xml | grep "" | kafa -n 1 | sed -e "s / sürüm // g" | sed -e "s / \ s * [<> /] * // g"

Ben cmdline iyi test üzerinde test

grep "" pom.xml | kafa -n 1 | sed -e "s / sürüm // g" | sed -e "s / \ s * [<> /] * // g"

aynı başka bir sürümüdür. MVn yüklü olmadan k8s Jenkins CI sürüm numarasını almak için bir ihtiyaç var bu yüzden bu en yararlı

hepinize teşekkürler.

mvn help:evaluate -Dexpression=project.version | sed -e 1h -e '2,3{H;g}' -e '/\[INFO\] BUILD SUCCESS/ q' -e '1,2d' -e '{N;D}' | sed -e '1q'

Sadece sedson zamanlarda project.versionmaven çıktısını ayıklamak için uyguladığım küçük filtre iyileştirmesi ekliyorum .

VERSION=$(head -50 pom.xml | awk -F'>' '/SNAPSHOT/ {print $2}' | awk -F'<' '{print $1}')

Bu, sürüm numarasını almak için kullandığım şeydi, bunu yapmanın daha iyi bir yol olacağını düşündüm