GitLab CI中运行PMD失败，添加echo命令后成功的原因咨询

AI 小北

2026-8-5

问题

我有一个GitLab项目，已创建.gitlab-ci.yml文件用于每次提交后运行PMD做代码扫描，配置内容如下：

image: "node:latest"

stages:
  - preliminary-testing

apex-code-scan:
  stage: preliminary-testing
  allow_failure: false
  script:
    - install_java
    - install_pmd
  artifacts:
    paths:
      - pmd-reports/

####################################################
# Helper Methods
####################################################

.sfdx_helpers: &sfdx_helpers |

  function install_java() {
    local JAVA_VERSION=11
    local JAVA_INSTALLATION=openjdk-$JAVA_VERSION-jdk
    echo "Installing ${JAVA_INSTALLATION}"
    apt update && apt -y install $JAVA_INSTALLATION
  }

  function install_pmd() {
    local PMD_VERSION=6.52.0
    local RULESET_PATH=ruleset.xml
    local OUTPUT_DIRECTORY=pmd-reports
    local SOURCE_DIRECTORY=force-app
    local URL=https://github.com/pmd/pmd/releases/download/pmd_releases%2F$PMD_VERSION/pmd-bin-$PMD_VERSION.zip
    
    # 原本我会下载并解压PMD源码，目前为测试已将其放入项目中

    # apt update && apt -y install unzip
    # wget $URL
    # unzip -o pmd-bin-$PMD_VERSION.zip
    # rm pmd-bin-$PMD_VERSION.zip
    echo "Installed PMD!"

    mkdir -p $OUTPUT_DIRECTORY
    echo "Going to run PMD!"
    ls
    echo "Start"
    pmd-bin-$PMD_VERSION/bin/run.sh pmd -d $SOURCE_DIRECTORY -R $RULESET_PATH -f xslt -P xsltFilename=pmd_report.xsl -r $OUTPUT_DIRECTORY/pmd-apex.html
    echo "Done"
    rm -r pmd-bin-$PMD_VERSION
    echo "Remove pmd"
  }

before_script:
  - *sfdx_helpers

运行流水线时，PMD启动后会失败；但修改PMD的/bin/run.sh文件，在末尾添加echo "Done1"命令后，流水线就能成功执行。修改前后的run.sh内容如下：

修改前（执行失败）：

...
java ${HEAPSIZE} ${PMD_JAVA_OPTS} $(jre_specific_vm_options) -cp "${classpath}" "${CLASSNAME}" "$@"

修改后（执行成功）：

...
java ${HEAPSIZE} ${PMD_JAVA_OPTS} $(jre_specific_vm_options) -cp "${classpath}" "${CLASSNAME}" "$@"
echo "Done1" # This is the last line in the file

我完全搞不懂这个现象的原因，希望有人解释为什么在.sh文件末尾加echo命令能让流水线成功执行。

原因分析

这种情况核心是Shell脚本的退出码规则结合GitLab流水线的判定逻辑导致的，具体可以拆解成几点：

Shell脚本的退出码覆盖机制
Shell脚本默认会以最后一条执行命令的退出码作为整个脚本的最终退出码。修改前，run.sh的最后一条命令是启动PMD的Java进程，如果这个Java进程因为某些原因（比如代码扫描报错、资源不足、输出流异常）返回了非0的退出码，整个run.sh就会带着这个失败码退出，GitLab流水线会直接判定任务失败。

而添加echo "Done1"后，这条命令的退出码永远是0（只要echo能正常执行），它会覆盖之前Java命令的退出码，让整个run.sh脚本返回0，GitLab就会认为任务执行成功——相当于用一个肯定成功的操作，掩盖了之前Java命令可能存在的失败。

子进程回收与信号传递问题
在GitLab Runner的容器环境中，Java进程可能因为终端信号（比如SIGPIPE）或者资源回收不及时，导致进程没有正常退出，Shell会捕获到异常信号并返回非0码。而在后面加一条echo命令，相当于强制Shell完成子进程的回收流程：echo是轻量级命令，它会让Shell在执行完Java进程后，再执行一个无风险的操作，确保整个脚本的执行流程完整收尾，避免了异常信号直接传递给GitLab Runner。
输出流缓冲的收尾作用
PMD的Java进程如果输出大量内容，可能会出现标准输出/错误流的缓冲没有及时刷新的情况，导致GitLab Runner误认为进程卡住或者输出异常，从而终止任务。添加echo命令后，会强制刷新输出流，让Runner能接收到明确的结束信号，判定任务完成。

需要注意的是，添加echo只是掩盖了表面的失败状态，PMD的实际执行可能仍然存在问题。建议你检查Java命令的执行日志，查看具体的错误码和报错信息，这才是解决根本问题的关键。

内容的提问来源于stack exchange，提问作者Tyler Edwards