Mavenプロジェクトバージョンをbashコマンドラインに取得する方法

以前、Mavenプロジェクトのバージョンをコマンドラインから変更して新しい問題を引き起こす方法について質問しました。

以前は、バージョンがコマンドライン（bash）から簡単にgrepして解析できるプロパティとして保存されていたため、バージョン番号を取得できました。これでpom.xml要素が使用されるようになりましたが、すべての依存関係とおそらく他の依存関係もこれを使用しているため、一意ではなくなりました。xmlを解析するための外部ツールまたは非常にコンテキストに対応したsedコマンドがないと、bashスクリプトで現在のバージョン番号を取得する方法はないと思います。

私の意見で最もクリーンなソリューションは、Mavenがこのバージョン情報を配布することです。さまざまなプロパティを取得するためのカスタムmavenプラグインを作成することを考えていましたが、最初にここで質問したいと思いました。

それで、${project.version}コマンドラインに値を取得する簡単な方法はありますか？前もって感謝します。

解決

お手伝いありがとう。私はcd手動でディレクトリに行かなければなりませんでしたが、それは簡単に行うことができます。私のbashスクリプトには

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 } }'`

これにより、次に進むことができる現在のバージョンがわかります。Greppingの方が単純かもしれませんが、できるだけ堅牢にしたいと思ったので、番号で始まる最初の行に満足し、バージョン番号としてこれを処理しようとしました。

# 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/"
}

そして、私はこれを単に呼び出すことで使用します

new_version=$(advance_version $version)

これが誰かを助けることを願っています。

Mavenのヘルププラグインは何とかすでにこのために何かを提案しています。

• help:evaluate インタラクティブモードでユーザーが指定したMaven式を評価します。

コマンドラインでそれを呼び出して、を取得する方法を次に示します${project.version}。

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

トムのExec Mavenプラグインによるソリューションははるかに優れていますが、必要以上に複雑です。私にとってはそれはとても簡単です：

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

私はいくつかの研究をしていて、次のことがわかりました：

1. Mavenは、DevOpsツールとの統合がCLIツールに関するいくつかの優れたプラクティスに従っていないために容易ではないため、非難されています。（参照：https : //youtu.be/1ILEw6Qca3U?t=372）

2. 以前のアサーションに触発されて、私はmavenのソースコードとmaven-help-pluginを確認することにしました。彼らはmavenの-qスイッチを少し修正したようです（私はバージョン3.5.3を使用しています）ので、これを渡すと、mavenの使用を妨げる迷惑な意味のないロギングのすべてが得られなくなります自動化スクリプト内。したがって、次のようなものを使用できるはずです。

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

   問題は、このコマンドは何も出力しないことです。デフォルトでは、ヘルププラグインは-qスイッチによってサイレントにされたロガーを介して出力するためです。（プラグインの利用可能な最新バージョンは2018年6月3日にリリースされた3.1.0です）

3. Karl Heinz Marbaise（https://github.com/khmarbaise）は、次の方法で呼び出すことができるオプションのパラメーターを追加することで修正しました。

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

   コミットの説明は次の場所にあります：（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 '\['

トップの答えは私の意見ではかなりごみです。Mavenコンソールの出力をハックアウトするには、grepの束を使用する必要があります。仕事に適したツールを使用してみませんか？xpath構文は、XMLデータ構造にアクセスするための意図された方法であるため、バージョン番号を取得するための最良のアプローチです。以下の式は、要素の「ローカル名」を使用してpomをトラバースしています。つまり、xmlに存在する場合と存在しない場合がある名前空間宣言を無視しています。

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

これにより、ログエントリを出力からgrepする必要がなくなります。

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

これは私が見つけた最もクリーンなソリューションです：

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

利点：

• これは、すべてのオペレーティングシステムとすべてのシェルで正常に動作します。
• 外部ツールは必要ありません！
• [重要]これは、プロジェクトバージョンが親から継承されている場合でも機能します pom.xml

注意：

• maven-help-pluginバージョン3.2.0（以上）にはforceStdoutオプションがあります。3.2.0上記のコマンドを、アーティファクトにあるmvn-help-pluginの利用可能なバージョンのリストにある新しいバージョンに置き換えます（可能な場合）。
• オプション-qメッセージ冗長抑止し（[INFO]、[WARN]など）

取得groupIdしたい場合はartifactId、この回答を確認してください。

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以上を持っている限り、これはうまくいくはずです。それより前のバージョンを使用している場合はpython-lxml、インポートをインストールしてlxml.etreeに変更します。この方法は迅速で、追加のプラグインをダウンロードする必要はありません。また、解析する必要があるファイルのように、xmllintで検証されない不正な形式のpom.xmlファイルでも機能します。MacおよびLinuxでテスト済み。

ここで他の回答のいくつかを使用しているとき、私はサイドケースに遭遇し続けたので、ここにさらに別の選択肢があります。

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

バージョンを一時ファイルに書き込むことを気にしない場合は、（grep / sedを使用しない）私にとってうまく機能する別の解決策があります。（編集：一時的なファイルの手間なしにはるかに簡単な解決策についてはrjrjrの答えを参照してください）

バイナリと一緒にExec Mavenプラグインを使用しますecho。Mavenヘルププラグインとは対照的に、Execプラグインは、grep / sedをバイパスするために使用できるファイルへの出力リダイレクトを許可し、複数行のバージョン文字列（バージョンタグにCDATAブロックがある）などの奇妙なものを解析することも可能にします。少なくともある程度は。

#!/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"

参考までに、MavenのSimple SLF4Jロギングをコマンドラインで直接構成して、必要なものだけを出力するように構成することが可能です。

• org.slf4j.simpleLogger.defaultLogLevel=WARN そして
• org.slf4j.simpleLogger.log.org.apache.maven.plugins.help=INFO

http://www.slf4j.org/api/org/slf4j/impl/SimpleLogger.htmlに記載されているとおり

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して次のように取得できます。

$ 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

これはワンライナーであることに注意してください。MAVEN_OPTSこの特定のmvn実行のためにのみ書き換えられています。

Downloaded:元の割り当てを壊していたいくつかの偽の行が出力に含まれていることに気づきました。これが私が解決したフィルターです。それが役に立てば幸い！

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

編集

理由は100％わかりませんが、Jenkinsのビルド後スクリプトでこれを実行すると、出力はとして出力されていました[INFO]version。[INFO]0.3.2。

出力をファイルにダンプし、最初のフィルターをBASHから直接実行しましたが、正常に動作します。したがって、Jenkinsランドで何が行われているのかがわかりません。

Jenkinsで100％にするために、フォローアップsedフィルターを追加しました。これが私の最新です

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

編集

ここで最後に1つ注意します。私trはまだ/r/n0.3.2（Jenkins経由で実行している場合にのみ）などの結果をもたらしていることがわかりました。に切り替えawkたところ、問題は解消されました。私の最終的な作業結果

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=''

単純なmavenのみのソリューション

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

ボーナスポイントについては、バージョンの一部を解析しました

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}'

私は最近、この正確な問題を解決するRelease Candidate Mavenプラグインを開発しました。そのため、ハッキーなシェルスクリプトに頼ったり、出力を解析したりする必要はありません。maven-help-plugin。

たとえば、Mavenプロジェクトのバージョンをターミナルに出力するには、次のコマンドを実行します。

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

これは次のような出力を提供しますmaven-help-plugin：

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

ただし、任意の出力形式を指定することもできます（これにより、TeamCityなどのCIサーバーがログからバージョンを取得できるようになります）。

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

その結果：

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

出力をファイルに保存するには（JenkinsなどのCIサーバーが使用できるようにするため）：

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

結果のversion.propertiesファイルは次のようになります。

PROJECT_VERSION=1.0.0-SNAPSHOT

上記すべてに加えて、Release Candidateでは、POMで定義したAPIバージョンに基づいて、プロジェクトのバージョン（CIサーバーでおそらく行うことになるもの）を設定することもできます。

Mavenライフサイクルの一部として使用されているリリース候補の例を確認したい場合pom.xmlは、他のオープンソースプロジェクトであるJenkins用のビルドモニターを参照してください。

Mavenを必要としないオプションも1つあります。

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

Mavenプロジェクトバージョンを出力し[INFO]、Downloadメッセージやメッセージからの不要な出力を抑制する、わかりやすいオールインワンソリューション：

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

同じことですが、2行に分割します。

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

出力： 4.3-SNAPSHOT

したがって、project.version単純なbashスクリプトでを使用すると、

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

このページの他のソリューションは、すべてのトリックを1つにまとめているようには見えませんでした。

このバグはmaven-help-plugin 3.0.0で修正されているので、もっと簡単になるはずです。

これは、はるかに簡単なbashカットアンドペーストソリューションです。

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

反響する

1.4

自分に合ったバランスを見つけました。mvn packagemaven-archiverプラグインがtarget/maven-archiver/pom.propertiesこのようなコンテンツで作成した後

version=0.0.1-SNAPSHOT
groupId=somegroup
artifactId=someArtifact

そして私はそれを実行するためだけにbashを使用しています

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

その後

echo $version
0.0.1-SNAPSHOT

もちろん、このファイルを実行するのは安全ではありませんが、実行を簡単にperlまたはbashスクリプトに変換して、そのファイルから環境変数を読み取って設定することができます。

これはオフラインでmvnに依存せずに機能しました：

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

EnvInjectプラグインを介して出力をファイルにリダイレクトし、ジョブ環境に戻すことができるため、Execプラグインは出力解析なしで機能します。

質問に基づいて、私は以下のスクリプトを使用して、すべてのmaven親/サブモジュールのバージョン番号を自動的に増やします：

#!/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

mvn（ほとんどの回答が示唆するように）回答を提供するか、から回答を抽出しますpom.xml。2番目のアプローチの唯一の欠点は、<version/>タグの値を非常に簡単に抽出できることですが、それがリテラル、つまりMavenプロパティでない場合にのみ意味があります。とにかく私はこのアプローチを選びました：

• mvn 冗長にする方法であり、出力をフィルタリングするのは好きではありません。
• のmvn読み取りは、の読み取りに比べて非常に遅くなりpom.xmlます。
• 私は常にリテラル値を使用しています<version/>。

mvn-versionは、プロジェクトのバージョン（存在する場合）または親プロジェクトのバージョン（存在する場合）を読み取っzshて出力するxmlstarletために使用するシェルスクリプトですpom.xml。

$ mvn-version .
1.0.0-SNAPSHOT

利点は、実行するよりもはるかに速いことです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

私のマシンの違いは2桁以上です。

私はTravisの仕事中にこの要件を正確に必要としていますが、複数の値が必要です。私はこの解決策から始めますが、複数回呼び出すと、これは非常に遅くなります（5つの式が必要です）。

pom.xmlの値を.shファイルに抽出する単純なmavenプラグインを作成しました。

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

それを生成します：

#!/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';

今、あなたは単にファイルを調達することができます

source .target/ci-tools-env.sh

楽しんで。

UNIXシェルでワンライナーを使用しています...

猫pom.xml | grep "" | 頭-n 1 | sed -e "s / version // g" | sed -e "s / \ s * [<> /] * // g"

この行はシェルスクリプトまたはエイリアスとして非表示にできます。

これは上からの編集です

猫pom.xml | grep "" | 頭-n 1 | sed -e "s / version // g" | sed -e "s / \ s * [<> /] * // g"

私はそれをcmdlineでテストしてうまくいきました

grep "" pom.xml | 頭-n 1 | sed -e "s / version // g" | sed -e "s / \ s * [<> /] * // g"

同じの別のバージョンです。mvnがインストールされていないk8sのJenkins CIのバージョン番号を取得する必要があるため、これが最も役立ちます

皆さんありがとう。

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'

Mavenの出力sedから抽出するために最近実装した小さなフィルターの改善を追加していproject.versionます。

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

これは私がバージョン番号を取得するために使用したものですが、それを行うにはより優れたmavenの方法があったと思います