如何将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 } }'`

这给了我当前的版本，然后可以进行升级。暂存可能会更简单，但是我想我想尽可能地强大，所以我对以数字开头的第一行感到满意，并尝试将其作为版本号来处理。

# 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

Tom使用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 '\['

在我看来，最佳答案是非常垃圾，您必须使用一堆grep来破解Maven控制台输出。为什么不使用正确的工具进行工作？使用xpath语法是检索版本号的最佳方法，因为它是访问XML数据结构的预期方法。下面的表达式使用元素的“本地名称”遍历pom，换句话说，就是忽略xml中可能存在或可能不存在的名称空间声明。

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

这将避免需要从输出中删除日志条目：

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

优点：

• 在所有操作系统和所有外壳上都可以正常工作。
• 无需任何外部工具！

注意：

• maven-help-plugin版本3.2.0（及更高版本）具有forceStdout选项。您可以使用来自工件的mvn-help-plugin3.2.0的可用版本列表（如果可用）中的较新版本替换上述命令。
• 选项-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。这种方法快速，不需要下载任何额外的插件。它也适用于格式不正确的pom.xml文件，这些文件无法通过xmllint进行验证，例如我需要解析的文件。在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，甚至可以解析诸如多行版本字符串（在version标签中带有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通过我的第一个过滤器运行它，它工作正常。

为了在詹金斯获得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')

编辑

最后一点在这里..我发现tr了仍在造成之类的东西/r/n0.3.2（又只能通过詹金斯运行时）。切换至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插件，它解决了这个确切的问题，因此您不必求助于任何骇人听闻的Shell脚本并解析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] ------------------------------------------------------------------------

但是，您也可以指定任意的输出格式（以便CI服务器（例如TeamCity）可以从日志中获取版本：

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服务器上所做的事情）。

如果您希望看到一个示例Release Release用作Maven生命周期的一部分，请查看pom.xml我的另一个开源项目－Build Monitor for Jenkins的示例。

还有一种不需要Maven的选项：

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 '\['

同样，但分为两行：

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"

此页面上的其他解决方案似乎并未将所有技巧结合在一起。

应该更容易，因为此错误已在maven-help-plugin 3.0.0中修复：MPH-99 Evaluate在安静模式下没有输出。

到目前为止，这是最简单的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

Exec插件无需任何输出解析即可工作，因为可以将输出重定向到文件中，并通过EnvInject插件注入到作业环境中：

基于这个问题，我在下面使用此脚本自动增加所有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。第二种方法的唯一缺点是，您可以非常轻松地提取<version/>标记的值，但是仅当它是文字时才有意义，即不是Maven属性。我之所以选择这种方法，是因为：

• mvn 是冗长的方式，我只是不喜欢过滤其输出。
• 开始mvn时相比很慢阅读pom.xml。
• 我总是在中使用文字值<version/>。

mvn-version是一个zshshell脚本，用于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

我的机器上的差异大于两个数量级。

在Travis工作期间，我确实需要此要求，但需要多个值。我从此解决方案开始，但是在多次调用时这很慢（我需要5个表达式）。

我编写了一个简单的maven插件，将pom.xml的值提取到.sh文件中。

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 shell中使用单线...

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

您可以将此行隐藏在Shell脚本中或作为别名。

这是上面的编辑

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

我只是添加了sed我最近实现的project.version从Maven输出中提取的小型过滤器改进。

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

这是我用来获取版本号的方式，以为会有更好的行家方式